# php_manual

id: IntlCalendar::setLenient
type: function
doc:
<comment>Description:</comment>
  Establecer si la interpretación de la fecha/hora es tolerante
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Define si el calendario está en ‘modo tolerante’. En dicho modo, se aceptan algunos de valores
  fuera de rango para algunos campos, siendo el comportamiento similar al de <strong>IntlCalendar::add()</strong> (es
  decir, el valor sobrepasa, acarreando más campos significativos cada vez). Si el modo tolerante
  está desactivado, tales valores generarán un error.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>        El recurso IntlCalendar.
  <info>string</info>        <strong>$isLenient</strong>  Use <info>true</info> para activar el modo tolerante; <info>false</info> de lo contrario.

<comment>Return:</comment>
  <info>ReturnType</info>  Devuelve <info>true</info> en caso de éxito. Los errores solamente pueden ocurrir debido a
              parámetros no válidos.


id: IntlCalendar::setMinimalDaysInFirstWeek
type: function
doc:
<comment>Description:</comment>
  Establecer el número de días mínimo que puede tener la primera semana de un año o mes
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el número mínimo de días que debe tener la primera semana de un año o mes en el nuevo
  año o mes. Por ejemplo, en el calendario gregoriano, si este valor es 1, la primera semana de año
  incluirá necesariamente el 1 de enero, mientras que si este valor es 7, la semana con el 1 de
  enerio será la primera semana del año únicamente si el día de la semana para el 1 de enero
  coincide con el día de la semana devuelto por <strong>IntlCalendar::getFirstDayOfWeek()</strong>; de lo contrario
  será la última semana del año anterior.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>          El recurso IntlCalendar.
  <info>int</info>           <strong>$minimalDays</strong>  El número mínimo de días a establecer.

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


id: IntlCalendar::setRepeatedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Establecer el comportamiento para tratar horas repetidas en transiciones negativas de índices de
  zonas horarias
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece la estrategia a usar para tratar con las horas repetidas siempre que el reloj se atrase
  durante las transiciones del final del horario de verano (DST). El valor predeterminado es
  <info>IntlCalendar::WALLTIME_LAST</info> (tomado como si fuera el instante pos-DST). El otro valor posible es
  <info>IntlCalendar::WALLTIME_FIRST</info> (tomando el mismo instante que ocurre durante el DST).
  
  Esta función requiere ICU 4.9 o posterior.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>             El recurso IntlCalendar.
  <info>int</info>           <strong>$wallTimeOption</strong>  Una de las constantes <info>IntlCalendar::WALLTIME_FIRST</info> o
                                 <info>IntlCalendar::WALLTIME_LAST</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito. Los errores solamente pueden ocurrir debido a parámetros no
        válidos.

<comment>See Also:</comment>
   * intlCalendar::getRepeatedWallTimeOption
   * intlCalendar::setSkippedWallTimeOption
   * intlCalendar::getSkippedWallTimeOption


id: IntlCalendar::setSkippedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Establecer el comportamiento para tratar horas omitidas en transiciones positivas de índices de
  zonas horarias
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece la estrategia a usar para tratar con las horas omitidas siempre que el reloj se adelante
  durante las transiciones del inicio del horario de verano (DST). El valor predeterminado es
  <info>IntlCalendar::WALLTIME_LAST</info> (tomado como si fuera el mismo instante el de adelantar el reloj una
  hora). Los valores alternativos son <info>IntlCalendar::WALLTIME_FIRST</info> (mismo instante que el de atrasar
  el reloj una hora) y <info>IntlCalendar::WALLTIME_NEXT_VALID</info> (mismo instante que cuando comienza el
  DST).
  
  Esto afecta solamente a los instantes representados por el calendario (como en
  <strong>IntlCalendar::getTime()</strong>); los valores de los campos no serán sobrescritos en consencuencia.
  
  El calendario debe ser tolerante para que esta opción tenga efecto, si no, el intento de
  establecer un instante no existente provocará un error.
  
  Esta función requiere ICU 4.9 o posterior.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>             El recurso IntlCalendar.
  <info>int</info>           <strong>$wallTimeOption</strong>  Una de las constantes <info>IntlCalendar::WALLTIME_FIRST</info>,
                                 <info>IntlCalendar::WALLTIME_LAST</info> o <info>IntlCalendar::WALLTIME_NEXT_VALID</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito. Los errores solamente pueden ocurrir debido a parámetros no
        válidos.

<comment>See Also:</comment>
   * intlCalendar::getSkippedWallTimeOption
   * intlCalendar::setRepeatedWallTimeOption
   * intlCalendar::getRepeatedWallTimeOption


id: IntlCalendar::setTime
type: function
doc:
<comment>Description:</comment>
  Establecer el momento del calendario en milisegundos desde la época
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el instante representado por este objeto. El instante está representado por un valor de
  tipo <info>float</info> que debería ser un número entero de milisegundos desde la época (1 Jan 1970
  00:00:00.000 UTC), ignorando los segundos intercalares. seconds. Todos los valores de los campos
  se recalcularán en consecuencia.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>   El recurso IntlCalendar.
  <info>float</info>         <strong>$date</strong>  Un instante representado por el número de milisegundos entre dicho instante y
                       la época, ignorando los segundos intercalares.

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


id: IntlCalendar::setTimeZone
type: function
doc:
<comment>Description:</comment>
  Establecer la zona horaria usada por este calendario
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Define una nueva zona horaria para este calendario. El momento representado por el objeto se
  preserva en detrimento de los valores de los campos.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>       El recurso IntlCalendar.
  <info>mixed</info>         <strong>$timeZone</strong>  La nueva zona horaria que usará este calendario. Se puede especificar de
                           las siguientes maneras:
                           
                           
                           
                           <info>null</info>, en cuyo caso se usará la zona horaria predeterminada, tal como está
                           especificada en el ajuste ini date.timezone o a través de la función
                           <strong>date_default_timezone_set()</strong> y como es devuelto por
                           <strong>date_default_timezone_get()</strong>.  Un <class>IntlTimeZone</class>, que se usará directamente.
                           Un <class>DateTimeZone</class>. Su identificador será extraido y se creará un objeto de
                           zona horaria de ICU; la zona horaria será proporcionada por la base de
                           datos de ICU, no por la de PHP.  Un <info>string</info>, que debería ser un
                           identificador de zona horaria de ICU válido. Véase
                           <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Los índices puros como
                           <return>"GMT+08:30"</return> también se aceptan.
                           
                           <info>null</info>, en cuyo caso se usará la zona horaria predeterminada, tal como está
                           especificada en el ajuste ini date.timezone o a través de la función
                           <strong>date_default_timezone_set()</strong> y como es devuelto por
                           <strong>date_default_timezone_get()</strong>.
                           
                           Un <class>IntlTimeZone</class>, que se usará directamente.
                           
                           Un <class>DateTimeZone</class>. Su identificador será extraido y se creará un objeto de
                           zona horaria de ICU; la zona horaria será proporcionada por la base de
                           datos de ICU, no por la de PHP.
                           
                           Un <info>string</info>, que debería ser un identificador de zona horaria de ICU
                           válido. Véase <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Los índices
                           puros como <return>"GMT+08:30"</return> también se aceptan.

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


id: IntlCalendar::toDateTime
type: function
doc:
<comment>Description:</comment>
  Convertir un objeto IntlCalendar a un objeto DateTime
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Crea un objeto <class>DateTime</class> que representa el mismo instante (con precisión de segundo, con un límite
  de error menor que 1 segundo) y que posee una zona horaria análoga a este objeto (siendo la
  diferencia que la zona horaria de <class>DateTime</class> será respaldada por las zonas horarias de PHP mientras
  que la zona horararia de <class>IntlCalendar</class> será respaldada por las de ICU).

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>  El recurso IntlCalendar.

<comment>Return:</comment>
  <info>DateTime</info>  Un objeto <class>DateTime</class> con la misma zona horaria que este objeto (aunque se emplea la base
            de datos de PHP en lugar de la de ICU) y el mismo instante, excepto por la preción más
            pequeña (precisión de segundos en lugar de milisegundos). Devuelve <info>false</info> en caso de
            error.

<comment>See Also:</comment>
   * IntlCalendar::fromDateTime
   * IntlCalendar::getTime
   * IntlCalendar::createInstance
   * DateTime:__construct


id: IntlChar
type: class
doc:
<comment>Description:</comment>
  <class>IntlChar</class> proporciona acceso a varios métodos de utilidades que pueden emplearse para obtener
  información de caracteres Unicode.
  
  Los métodos y las constantes cumplen estrechamente con los nombres y comportamientos empleados por
  la biblioteca ICU subyacente.


id: IntlChar::charAge
type: function
doc:
<comment>Description:</comment>
  Obtener la «edad» del punto de código
  
  Obtiene la «edad» del punto de código.
  
  La «edad» es la versión de Unicode cuando el punto de código fue diseñado por primera vez (como un
  no carácter o para Uso Privado) o se le asignó un carácter. Esta puede ser útil para evitar la
  emisión de puntos de código a procesos receptores que no aceptan nuevos caracteres.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>array</info>  El número de versión de Unicode, como <info>array</info>. Por ejemplo, la versión 1.3.31.2 sería
         representada como <return>[1, 3, 31, 2]</return>.

<comment>See Also:</comment>
   * <strong>IntlChar::getUnicodeVersion()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>


id: IntlChar::charDigitValue
type: function
doc:
<comment>Description:</comment>
  Obtener el valor del dígito decimal de un carácter de dígito decimal
  
  Devuelve el valor del dígito decimal de un carácter de dígito decimal.
  
  Estos caracteres tienen la categoría general "Nd" (número de dígito decimal) y un Numeric_Type de
  Decimal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  El valor del dígito decimal de <strong>$codepoint</strong>, o <return>-1</return> si no es un carácter de dígito decimal.

<comment>See Also:</comment>
   * <strong>IntlChar::getNumericValue()</strong>


id: IntlChar::charDirection
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de la categoría bidireccional de un punto de código
  
  Devuelve el valor de la categoría bidireccional del punto de código, que se emplea en el algoritmo
  bidireccional de Unicode (UAX #9).
  
  Algunos puntos de código no asignados poseen valores «bidi» de R o AL debido a que están en
  bloques que están reservados para escrituras de derecha a izquierda.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  El valor de la categoría bidireccional; una de las siguietnes constantes:
       <info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR</info><info>IntlChar::CHAR_DIRECTION_ARABIC_NUMBER</info><info>IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE</info><info>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT</info><info>IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK</info><info>IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT</info>


id: IntlChar::charFromName
type: function
doc:
<comment>Description:</comment>
  Buscar un carácter Unicode por su nombre y devolver su valor de punto de código
  
  Busca un carácter Unicode por su nombre y devolver su valor de punto de código.
  
  El nombre se compara de forma exacta y completa. Si el nombre no corresponde a un punto de código
  se devuelve <info>false</info>.
  
  Un nombre de Unicode 1.0 es comparado solamente si difiere de su nombre moderno. Los nombres de
  Unicode están todos en mayúsculas. Los nombres ampliados están en minúculas y seguidos por un
  número hexadecimal en mayúsculas y entre comillas angulares.

<comment>Param:</comment>
  <info>string</info>  <strong>$characterName</strong>  El nombre completo del carácter Unicode.
  <info>int</info>     <strong>$nameChoice</strong>     El conjunto de nombres a utilizar para la consulta. Puede ser una de estas
                          constantes: <info>IntlChar::UNICODE_CHAR_NAME</info>
                          (predeterminado)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

<comment>Return:</comment>
  <info>int</info>  El valor Unicode del punto de código con el nombre dado (como <info>integer</info>), o <info>false</info> si no existe
       tal punto de código.

<comment>See Also:</comment>
   * <strong>IntlChar::charName()</strong>
   * <strong>IntlChar::enumCharNames()</strong>


id: IntlChar::charMirror
type: function
doc:
<comment>Description:</comment>
  Obtener el carácter de «imagen reflejada» de un punto de código
  
  Hace corresponder el carácter especificado con un carácter de «imagen reflejada».
  
  Para caracteres con la propiedad Bidi_Mirrored, las implementaciones a veces necesitan una
  correspondencia «pobre» con otro carácter de Unicode (punto de código) tal que el glifo
  predeterminado podría servir como la imagen reflejada del glifo predeterminado del carácter
  especificado. Esto es útil en la conversión de textos hacia y desde páginas de código con orden
  visual y para pantallas sin la capacidad de selección de glifos.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Devuelve otro punto de código Unicode que podría servir como sustituto de imagen reflejada,
         o el mismo <strong>$codepoint</strong> si no hay correspondencia o si <strong>$codepoint</strong> no posee la propiedad
         Bidi_Mirrored.
         
         El tipo devuelto será <info>integer</info> a menos que el punto de código se pase como un <info>string</info> UTF-8,
         en cuyo caso será devuelto un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::isMirrored()</strong>
   * <info>IntlChar::PROPERTY_BIDI_MIRRORED</info>


id: IntlChar::charName
type: function
doc:
<comment>Description:</comment>
  Obtener el nombre de un carácter Unicode
  
  Obtiene el nombre de un carácter unicode Unicode.
  
  Dependiendo de <strong>$nameChoice</strong>, el nombre del carácter resultante es el nombre «moderno» o el nombre
  que se definió en la versión 1.0 de Unicode. El nombre contiene solo caracteres «invariantes» como
  A-Z, 0-9, espacio y '-'. Solamente se obtiene un nombre de Unicode 1.0 si es diferente del nombre
  moderno y si ICU contiene datos sobre él.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>   El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                      SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)
  <info>int</info>    <strong>$nameChoice</strong>  El conjunto de nombres a utilizar para la consulta. Puede ser una de estas
                      constantes: <info>IntlChar::UNICODE_CHAR_NAME</info>
                      (predeterminado)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

<comment>Return:</comment>
  <info>string</info>  El nombre correspondiente, o una cadena vacía si no existe un nombre para este carácter.

<comment>See Also:</comment>
   * <strong>IntlChar::charFromName()</strong>
   * <strong>IntlChar::enumCharNames()</strong>


id: IntlChar::charType
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de la categoría general de un punto de código
  
  Devuelve el valor de la categoría general de un punto de código.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  Devuelve el tipo de la categoría general, que puede ser una de las siguientes constantes:
       <info>IntlChar::CHAR_CATEGORY_UNASSIGNED</info><info>IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES</info><info>IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_TITLECASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_MODIFIER_LETTER</info><info>IntlChar::CHAR_CATEGORY_OTHER_LETTER</info><info>IntlChar::CHAR_CATEGORY_NON_SPACING_MARK</info><info>IntlChar::CHAR_CATEGORY_ENCLOSING_MARK</info><info>IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK</info><info>IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER</info><info>IntlChar::CHAR_CATEGORY_LETTER_NUMBER</info><info>IntlChar::CHAR_CATEGORY_OTHER_NUMBER</info><info>IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</info><info>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</info><info>IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR</info><info>IntlChar::CHAR_CATEGORY_SURROGATE</info><info>IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_START_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_END_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_MATH_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_OTHER_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT</info>


id: IntlChar::chr
type: function
doc:
<comment>Description:</comment>
  Devolver el carácter Unicode mediante su valor de punto de código
  
  Devuelve una cadena que contiene el carácter especificado por el valor del pundo de código de
  Unicode.
  
  Esta función complementa a <strong>IntlChar::ord()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>string</info>  Una cadena que contiene el carácter especificado por el valor del punto de código de
          Unicode.

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


id: IntlChar::digit
type: function
doc:
<comment>Description:</comment>
  Obtener el valor del dígito decimal de un punto de código para una base dada
  
  Devuelve el valor del dígito decimal de un punto de código en la base especificada.
  
  Si la base no está en el rango <return>2\<=base\<=36</return> o si el valor de <strong>$codepoint</strong> no es un dígito válido en la base especificada, devuelve <info>false</info>. Un carácter es un dígito válido si al menos algo de lo siguiente es verdadero: El carácter tienen un valor de dígito decimal. Tales caracteres posee la categoría general "Nd" (números de dígito decimal) y un Numeric_Type de Decimal. En este caso, el valor es el del dígito decimal del carácter.El carácter es una de las letras latinas mayúsculas 'A' hasta 'Z'. En este caso, el valor es c-'A'+10.El carácter es una de las letras latinas minúsculas 'a' hasta 'z'. En este caso, el valor es ch-'a'+10.Son admitidas las letras latinas tanto del rango ASCII (0061..007A, 0041..005A) como del rango ASCII de Ancho Completo (FF41..FF5A, FF21..FF3A).

<comment>Param:</comment>
  <info>string</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                      SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)
  <info>int</info>     <strong>$radix</strong>      La base (valor predeterminado: <return>10</return>).

<comment>Return:</comment>
  <info>int</info>  Devuelve el valor numérico representado por el carácter de la base especificada, o <info>false</info> si
       no existe el valor o si el valor excede a la base.
       
       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>IntlChar::forDigit()</strong>
   * <strong>IntlChar::charDigitValue()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <info>IntlChar::PROPERTY_NUMERIC_TYPE</info>


id: IntlChar::enumCharNames
type: function
doc:
<comment>Description:</comment>
  Enumerar todos los caracteres de Unicode con asignación dentro de un rango
  
  Enumera todos los caracteres de Unicode asignados entre los puntos de código de inicio y límite,
  (inclusive y exclusive, respectivamente) y se llama a una función para cada uno, pasando el valor
  del punto de código y el nombre del carácter.
  
  Para los nombres de Unicode 1.0, solamente se enumeran aquellos que difieren de los nombres
  modernos.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$start</strong>       El primer punto de código en el rango de la enumeración.
  <info>mixed</info>     <strong>$limit</strong>       Uno más del último punto de código en el rango de la enumeración (el
                         primero después del rango).
  <info>callable</info>  <strong>$callback</strong>    La función a invorcar para cada nombre de carácter. Se le pasarán los
                         siguientes tres argumentos: <info>integer</info><return>$codepoint</return> - El valor numérico del punto
                         de código<info>integer</info><return>$nameChoice</return> - El mismo valor que el del parámetro
                         <strong>$nameChoice</strong> de abajo<info>string</info><return>$name</return> - El nombre del carácter
  <info>int</info>       <strong>$nameChoice</strong>  El selector por cuyo tipo de nombres se va a enumerar. Puede ser cualquier
                         de estas constantes: <info>IntlChar::UNICODE_CHAR_NAME</info>
                         (predeterminada)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

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

<comment>See Also:</comment>
   * <strong>IntlChar::charName()</strong>
   * <strong>IntlChar::charFromName()</strong>


id: IntlChar::enumCharTypes
type: function
doc:
<comment>Description:</comment>
  Enumerar todos los puntos de código con sus categorías generales de Unicode
  
  Enumera de manera eficiente todos los puntos de código con sus categorías generales de Unicode.
  Esto es útil para construir estructuras de datos, para enumerar todos los puntos de código con
  asignación, etc.
  
  Para cada rango contiguo de puntos de código con una categoría general dada («tipo de carácter»),
  se invoca a la función <strong>$callback</strong>. Rangos adyacentes poseen tipos diferentes. El Estándar de
  Unicode garantiza que el valor numérico del tipo está entre 0..31.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La función a invocar para cada rango contiguo de puntos de código con la
                       misma categoría general. Se le pasarán los siguientes tres argumentos:
                       <info>integer</info><return>$start</return> - El punto de código de inicio del rango<info>integer</info><return>$end</return> - El punto
                       de código final del rango<info>integer</info><return>$name</return> - El tipo de categoría (una de las
                       constantes <info>IntlChar::CHAR_CATEGORY_*</info>)

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


id: IntlChar::foldCase
type: function
doc:
<comment>Description:</comment>
  Realiza un «plegamiento» de un punto de código
  
  El carácter dado se hace corresponder con un equivalente «plegado» ("case folding"); si el
  carácter no tiene dicho equivalente, se devuelve el carácter mismo.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)
  <info>int</info>    <strong>$options</strong>    <info>IntlChar::FOLD_CASE_DEFAULT</info> (predeterminada) o
                     <info>IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I</info>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el Simple_Case_Folding del punto de código, si lo hay; de lo contrario devuelve el
         punto de código en sí.


id: IntlChar::forDigit
type: function
doc:
<comment>Description:</comment>
  Obtener la representación de un carácter para un dígito y base dados
  
  Determina la representación de un carácter para un dígito específico en la base especificada.
  
  Si el valor de la base no es una base válida, o si el valor del dígito no es un dígito válido en
  la base especificada, devuelve el carácter null (<return>U+0000</return>).
  
  El argumento 'radix' es válido si es mayor o igual que <return>2</return> y menor o igual que <return>36</return>. El argumento
  'digit' es válido si <return>0 \<= dígito \< base</return>.
  
  Si el dígito es menor que <return>10</return>, devuelve '0' + dígito. De lo contrario, deuvleve el valor 'a' +
  dígito - 10.

<comment>Param:</comment>
  <info>int</info>  <strong>$digit</strong>  El número a convertir en un carácter.
  <info>int</info>  <strong>$radix</strong>  La base (valor predeterminado: <return>10</return>).

<comment>Return:</comment>
  <info>int</info>  La representación de un carácter (como <info>string</info>) del dígito especificado en la base
       especificada.

<comment>See Also:</comment>
   * <strong>IntlChar::digit()</strong>
   * <strong>IntlChar::charDigitValue()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <info>IntlChar::PROPERTY_NUMERIC_TYPE</info>


id: IntlChar::getBidiPairedBracket
type: function
doc:
<comment>Description:</comment>
  Obtener la pareja del carácter parentético de un punto de código
  
  Hace corresponder el carácter especificado con su pareja parentética.
  
  Para <return>Bidi_Paired_Bracket_Type!=None</return>, esto es lo mismo que <strong>IntlChar::charMirror()</strong>. De lo contrario
  se devuelve el mismo <strong>$codepoint</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el punto de código de la pareja parentética, o el mismo <strong>$codepoint</strong> si no existe
         tal correspondencia.
         
         El tipo devuelto será <info>integer</info> a menos que el punto de código se pase como un <info>string</info> UTF-8,
         en cuyo caso será devuelto un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET</info>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET_TYPE</info>


id: IntlChar::getBlockCode
type: function
doc:
<comment>Description:</comment>
  Obtener el bloque de asignación de Unicode que contiene a un punto de código
  
  Devuelve el bloque de asignación de Unicode que contiene al carácter.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  Devuelve el valor del bloque para <strong>$codepoint</strong>. Véanse las constantes <info>IntlChar::BLOCK_CODE_*</info>
       para los posibles valores devueltos.


id: IntlChar::getCombiningClass
type: function
doc:
<comment>Description:</comment>
  Obtener la clase de combinación de un punto de cógido
  
  Devuelve la clase de combinación de un punto de cógido.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  Devuelve la clase de combinación del carácter.


id: IntlChar::getFC_NFKC_Closure
type: function
doc:
<comment>Description:</comment>
  Obtener la propiedad FC_NFKC_Closure de un punto de código
  
  Obtiene la cadena de la propiedad FC_NFKC_Closure de un carácter.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena de la propiedad FC_NFKC_Closure de <strong>$codepoint</strong>, o una cadena vacía si no
          existe.


id: IntlChar::getIntPropertyMaxValue
type: function
doc:
<comment>Description:</comment>
  Obtener el valor máximo de una propiedad de Unicode
  
  Obtiene el valor máximo de una propiedad de Unicode enumerada/entera/binaria.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  La propiedad de Unicode a consultar (véanse las constantes <info>IntlChar::PROPERTY_*</info>).

<comment>Return:</comment>
  <info>int</info>  El valor máximo devuelto por <strong>IntlChar::getIntPropertyValue()</strong> para una propiedad de Unicode. <return>\<=0</return> si el selector de la propiedad está fuera de rango.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyMinValue
type: function
doc:
<comment>Description:</comment>
  Obtener el valor mínimo de una propiedad de Unicode
  
  Obtiene el valor mínimo de una propiedad de Unicode enumerada/entera/binaria.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  La propiedad de Unicode a consultar (véanse las constantes <info>IntlChar::PROPERTY_*</info>).

<comment>Return:</comment>
  <info>int</info>  El valor máximo devuelto por <strong>IntlChar::getIntPropertyValue()</strong> para una propiedad de Unicode. <return>0</return>
       si el selector de la propiedad está fuera de rango.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyValue
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de una propiedad de Unicode para un punto de código
  
  Obtiene el valor de una propiedad enumerada o entera de Unicode para un punto de código. También
  devuelve valores de propiedades binarias y de máscara.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)
  <info>int</info>    <strong>$property</strong>   La propiedad de Unicode a consultar (véanse las constantes
                     <info>IntlChar::PROPERTY_*</info>).

<comment>Return:</comment>
  <info>int</info>  Devuelve el valor numérico que es directamente el valor de la propiedad o, para propiedades
       enumeradas, que corresponde al valor numérico de la constante enumerada del tipo de
       enumeración respectivo del valor de la propiedad.
       
       Devuelve <return>0</return> o <return>1</return> (para <info>false</info>/<info>true</info>) para propiedades binarias de Unicode.
       
       Devuelve una máscara de bits para propiedades de máscara.
       
       Devuelve <return>0</return> si <strong>$property</strong> está fuera de rango o si la versión de Unicode no posee datos para la
       propiedad o para este punto de código.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getNumericValue
type: function
doc:
<comment>Description:</comment>
  Obtener el valor numérico de un punto de código de Unicode
  
  Obtiene el valor numérico de un punto de código de Unicode tal como está definido la Base de Datos
  de Caracteres de Unicode.
  
  Para caracteres sin un valor numérico en la Base de Datos de Caracteres de Unicode, esta función
  devolverá <info>float</info>(<return>-123456789</return>).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>float</info>  El valor numérico de <strong>$codepoint</strong>, o <info>float</info>(<return>-123456789</return>) si no hay definido ninguno.


id: IntlChar::getPropertyEnum
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de la constante de una propiedad para un nombre de propiedad dado
  
  Devuelve el valor de la constante de una propiedad para un nombre de propiedad dado, tal como se
  especifica en el fichero de base de datos de Unicode PropertyAliases.txt. Se reconocen también las
  variantes cortas, largas y otras.
  
  Además, esta función hace corresponder los nomres sintéticos "gcm" / "General_Category_Mask" con
  al propiedad <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>. Estos no mbres no se encuentran en
  PropertyAliases.txt.
  
  Esta función complementa a <strong>IntlChar::getPropertyName()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  El nombre de la propiedad a comparar. El nombre se compara empleando la
                  «comparación débil» ("loose matching"), como se describe en PropertyAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Devuelve un valor de una consntante <info>IntlChar::PROPERTY_</info>, o <info>IntlChar::PROPERTY_INVALID_CODE</info> si
       el nombre dado no coincide con ninguna propiedad.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyName()</strong>


id: IntlChar::getPropertyName
type: function
doc:
<comment>Description:</comment>
  Obtener el nombre Unicode de una propiedad
  
  Devuelve el nombre Unicode de una propiedad dada, tal como se da en el fichero de base de datos de
  Unicode PropertyAliases.txt.
  
  Además, esta función hace corresponder la propiedad <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info> con
  los nombres sintéticos "gcm" / "General_Category_Mask". Estos nombres no se encuentran en
  PropertyAliases.txt.
  
  Esta función complementa a <strong>IntlChar::getPropertyEnum()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>    La propiedad de Unicode a consultar (véanse las constantes
                    <info>IntlChar::PROPERTY_*</info>).
                    
                    No se debería utilizar <info>IntlChar::PROPERTY_INVALID_CODE</info>. Tambíen, si <strong>$property</strong>
                    está fuera de rango, devuelve <info>false</info>.
  <info>int</info>  <strong>$nameChoice</strong>  El selector a obtener por su nombre. Si está fuera de rango, devuelve <info>false</info>.
                    
                    Todas las propiedades tienen un nombre largo. La mayoría tienen un nombre corto,
                    otras no. Unicode tiene en cuenta nombres adicionales; si están presentes, serán
                    devueltos añadiendo 1, 2, etc., a <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre, o <info>false</info> si <strong>$property</strong> o <strong>$nameChoice</strong> están fuera de rango.
          
          Si un <strong>$nameChoice</strong> dado devuelve <info>false</info>, todos los valores mayores que <strong>$nameChoice</strong>
          devolverán <info>false</info>, con una excepción: si se devuelve <info>false</info> para
          <info>IntlChar::SHORT_PROPERTY_NAME</info>, entonces <info>IntlChar::LONG_PROPERTY_NAME</info> (y mayores) podrían
          aún devolver un valor distinto de <info>false</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyEnum()</strong>


id: IntlChar::getPropertyValueEnum
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de una propiedad para un nombre de valor dado
  
  Devuelve el entero del valor de la propiedad para un nombre de valor dado, tal como se especifica
  en el fichero de base de datos de Unicode PropertyValueAliases.txt. Se reconocen también las
  variantes cortas, largas y otras.
  
  Algunos de los nombres de PropertyValueAliases.txt solo serán reconocidos con
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, no con <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. Estos son:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int</info>     <strong>$property</strong>  La propiedad de Unicode a consultar (véanse las constantes
                     <info>IntlChar::PROPERTY_*</info>).
                     
                     Si está fuera de rango, o si este método no funciona con el valor dado, se
                     devuelve <info>IntlChar::PROPERTY_INVALID_CODE</info>.
  <info>string</info>  <strong>$name</strong>      El nombre del valor a comparar. El nombre se compara empleando la «comparación
                     débil» ("loose matching"), como se describe en PropertyValueAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Devuelve el entero del valor correspondiente, o <info>IntlChar::PROPERTY_INVALID_CODE</info> si el nombre
       dado no coincide con ningún valor de la propiedad dada, o si la propiedad es inválida.


id: IntlChar::getPropertyValueName
type: function
doc:
<comment>Description:</comment>
  Obtener el nombre Unicode para un valor de una propiedad
  
  Devuelve el nombre Unicode para un valor de una propiedad dado, como se da en el fichero de la
  base de datos de Unicode PropertyValueAliases.txt.
  
  Algunos de los nombres en PropertyValueAliases.txt solamente se pueden obtener con
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, no con <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. Estos son:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>    La propiedad de Unicode a consultar (véanse las constantes
                    <info>IntlChar::PROPERTY_*</info>).
                    
                    Si está fuera de rango o si el método no funciona con el valor dado, devuelve
                    <info>false</info>.
  <info>int</info>  <strong>$value</strong>       El selector para un valor de la propiedad dada. Si está fuera de rango, devuelve
                    <info>false</info>.
                    
                    En general, los valores válidos de rangos van de <return>0</return> a un máximo. Existen un par
                    de excepciones:  Los valores <info>IntlChar::PROPERTY_BLOCK</info> comienzan en el valor
                    <info>IntlChar::BLOCK_CODE_BASIC_LATIN</info> distinto de cero.  Los valores
                    <info>IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</info> no son contiguos y su rango es
                    0..240.
  <info>int</info>  <strong>$nameChoice</strong>  El selector a obtener por su nombre. Si está fuera de rango, devuelve <info>false</info>.
                    
                    Todas las propiedades tienen un nombre largo. La mayoría tienen un nombre corto,
                    otras no. Unicode tiene en cuenta nombres adicionales; si están presentes, serán
                    devueltos añadiendo 1, 2, etc., a <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre, o <info>false</info> si <strong>$property</strong> o <strong>$nameChoice</strong> están fuera de rango.
          
          Si un <strong>$nameChoice</strong> dado devuelve <info>false</info>, todos los valores mayores que <strong>$nameChoice</strong>
          devolverán <info>false</info>, con una excepción: si se devuelve <info>false</info> para
          <info>IntlChar::SHORT_PROPERTY_NAME</info>, entonces <info>IntlChar::LONG_PROPERTY_NAME</info> (y mayores) podrían
          aún devolver un valor distinto de <info>false</info>.


id: IntlChar::getUnicodeVersion
type: function
doc:
<comment>Description:</comment>
  Obtener la versión de Unicode
  
  Obtiene información de la versión de Unicode.
  
  El array de la versión contiene la información de la versión del estándar de Unicode que está
  utilizando ICU actualmente. Por ejemplo, la versión 3.1.1 de Unicode se representa como un array
  con los valores <return>[3, 1, 1, 0]</return>.

<comment>Return:</comment>
  <info>array</info>  Un array que contiene el número de versión de Unicode.

<comment>See Also:</comment>
   * <strong>IntlChar::charAge()</strong>


id: IntlChar::hasBinaryProperty
type: function
doc:
<comment>Description:</comment>
  Comprobar una propiedad de Unicode binaria para un punto de código
  
  Comprueba una propiedad de Unicode binaria para un punto de código.
  
  Unicode, especialmente en la versión 3.2, define muchas más propiedades que el conjunto original
  de UnicodeData.txt.
  
  Las API de propiedades tienen el objeto que reflejar las propiedades de Unicode tal como están
  definidas en la Base de Datos de Caracteres de Unicode (UCD - Unicode Character Database) y en los
  Informes Técnicos de (UTR - Unicode Technical Reports). Para detalles sobre las propiedades véase
  http://www.unicode.org/ucd/. Para los nombres de las propiedades de Unicode véase el fichero
  PropertyAliases.txt de la UCD.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)
  <info>int</info>    <strong>$property</strong>   La propiedad de Unicode a consultar (véanse las constantes
                     <info>IntlChar::PROPERTY_*</info>).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> o <info>false</info> según el valor de la propiedad binaria de Unicode para <strong>$codepoint</strong>.
        También devuelve <info>false</info> si <strong>$property</strong> está fuera de los límites o si la versión de Unicode no
        posee datos para para la propiedad o para este punto de código.

<comment>See Also:</comment>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::isIDIgnorable
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter ignorable
  
  Determina si el carácter especificado debería ser considerado como carácter ignorable en un
  identificador.
  
  <info>true</info> para caracteres con categoría general "Cf" (controles de formato) así como con controles ISO
  que no pertenecen al espacio en blanco (U+0000..U+0008, U+000E..U+001B, U+007F..U+009F).
  
  Observe que Unicode recomienda simplemente ignorar Cf (controles de formato).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es ignorable en identificadores, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::isIDPart
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es permisible en un identificador
  
  Determinar si el carácter especficiado es permisible en un identificador.
  
  <info>true</info> para caracteres con categorías generales "L" (letras), "Nl" (números de letra), "Nd" (dígitos
  decimales), "Mc" y "Mn" (marcas de combinación), "Pc" (puntuación de conexión), y
  u_isIDIgnorable(c).
  
  Esto es casi lo mismo que ID_Continue de Unicode (<info>IntlChar::PROPERTY_ID_CONTINUE</info>) excepto que
  Unicode recomienda ignorar Cf, el cual es menor que <strong>IntlChar::isIDIgnorable()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> podría darse en un identificador, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDStart()</strong>
   * <info>IntlChar::PROPERTY_ID_CONTINUE</info>


id: IntlChar::isIDStart
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es permisible como el primer carácter de un identificador
  
  Determna si el carácter especficado es permisible como el primer carácter de un identificador
  según Unicode (El Estándar de Unicode, Versión 3.0, capítulo 5.16 Identificadores).
  
  <info>true</info> para caracteres con categorías generales "L" (letras) y "Nl" (números de letra).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> podría iniciar un identificador, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_ID_START</info>


id: IntlChar::isISOControl
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un código de control de ISO
  
  Determina si el punto de código especificado es un código de control de ISO.
  
  <info>true</info> para U+0000..U+001f y U+007f..U+009f (categoría general "Cc").

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devueve <info>true</info> si <strong>$codepoint</strong> es un código de control de ISO, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>


id: IntlChar::isJavaIDPart
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es permisible en un identificador de Java
  
  Determina si el carácter especificado es permisible en un identificador de Java.
  
  Además de <strong>IntlChar::isIDPart()</strong>, <info>true</info> para caracteres con categoría general "Sc" (símbolos de
  moneda).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> podría darse en un identificador de Java, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <strong>IntlChar::isJavaIDStart()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isJavaIDStart
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es permisible como el primer carácter de un identificador de Java
  
  Determina si el carácter esepecficado es permisible como el incio de un identificador de Java.
  
  Además de <strong>IntlChar::isIDStart()</strong>, <info>true</info> para caracteres con categorías generales "Sc" (símbolos de
  moneda) y "Pc" (puntuación de conexión).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> podría iniciar un identificador de Java, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isJavaIDPart()</strong>
   * <strong>IntlChar::isalpha()</strong>


id: IntlChar::isJavaSpaceChar
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de espacio según Java
  
  Determina si es punto de código especificado es un carácter de espacio según Java.
  
  <info>true</info> para caracterse con la categoría general "Z" (separadores), lo que no incluye códigos de
  control (p.ej., TAB o Line Feed).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de espacio según Java, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isMirrored
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código posee la propiedad Bidi_Mirrored
  
  Determina si el punto de código posee la propiedad Bidi_Mirrored.
  
  Esta propiedad se establece para caracteres que se utilizan normalmente en contextos
  Deracha-Izquierda, siendo necesario mostrarlos con un glifo «reflejado».

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> posee la propiedad Bidi_Mirrored, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_MIRRORED</info>


id: IntlChar::isUAlphabetic
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código tiene la propiedad de Unicode Alphabetic
  
  Comprueba si un punto de código tiene la propiedad de Unicode Alphabetic.
  
  Esto es lo mismo que <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_ALPHABETIC)</return>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> tiene la propiedad de Unicode Alphabetic, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_ALPHABETIC</info>


id: IntlChar::isULowercase
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código tiene la propiedad de Unicode Lowercase
  
  Comprueba si un punto de código tiene la propiedad de Unicode Lowercase.
  
  Esto es lo mismo que <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_LOWERCASE)</return>
  
  Esto es diferente que <strong>IntlChar::islower()</strong> y devolverá <info>true</info> para más caracteres.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> tiene la propiedad de Unicode Lowercase, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>


id: IntlChar::isUUppercase
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código tiene la propiedad de Unicode Uppercase
  
  Comprueba si un punto de código tiene la propiedad de Unicode Uppercase.
  
  Esto es lo mismo que <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_UPPERCASE)</return>
  
  Esto es diferente que <strong>IntlChar::isupper()</strong> y devolverá <info>true</info> para más caracteres.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> tiene la propiedad de Unicode Uppercase, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>


id: IntlChar::isUWhiteSpace
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código tiene la propiedad de Unicode White_Space
  
  Comprueba si un punto de código tiene la propiedad de Unicode White_Space.
  
  Esto es lo mismo que <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_WHITE_SPACE)</return>
  
  Esto es diferente de <strong>IntlChar::isspace()</strong> y de <strong>IntlChar::isWhitespace()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> tiene la propiedad de Unicode White_Space, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_WHITE_SPACE</info>


id: IntlChar::isWhitespace
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de espacio en blanco según ICU
  
  Determina si el punto de código es un carácter de espacio en blanco según ICU.
  
  Un carácter se considera un carácter de espacio en blanco de Java si satisface uno de los
  siguientes criterios: Es un carácter Separador de Unicode (categorías "Z" = "Zs" o "Zl" o "Zp"),
  pero no es también un espacio de no ruptura (U+00A0 NBSP o U+2007 Figure Space o U+202F Narrow
  NBSP).Es un U+0009 HORIZONTAL TABULATION.Es un U+000A LINE FEED.Es un U+000B VERTICAL
  TABULATION.Es un U+000C FORM FEED.Es un U+000D CARRIAGE RETURN.Es un U+001C FILE SEPARATOR.Es un
  U+001D GROUP SEPARATOR.Es un U+001E RECORD SEPARATOR.Es un U+001F UNIT SEPARATOR.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de espacio en blanco según ICU, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isalnum
type: function
doc:
<comment>Description:</comment>
  Comporbar si un punto de código es un carácter alfanumérico
  
  Determina si el punto de código especificado es un carácter alfanumérico (letra o dígito). <info>true</info>
  para caracteres con las categorías generales "L" (letras) y "Nd" (números de dígito decimal).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un caracter alfanumérico, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isalpha
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un caracter de letra
  
  Determina si el punto de código especificado es un carácter de letra. <info>true</info> para las categorías
  generales "L" (letras).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de letra, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isbase
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter base
  
  Determina si el punto de código especificado es un carácter base. <info>true</info> para las categorías
  generales "L" (letras), "N" (números), "Mc" (marcas de combinación de espaciado), y "Me" (marcas
  envolventes).
  
  Esto es diferente de la definición de Unicode del capítulo 3.5, cláusula de conformidad D13, que
  define a los caracteres base como todos los caracteres (no Cn) que no combinan con caracteres
  precedentes (M) y que tampoco son caracteres de control (Cc) o de formato (Cf).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un caracter base, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isblank
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter «en blanco» o de «espacio horizontal»
  
  Determina si el punto de código especificado es un carácter «en blanco» o de «espacio horizontal»
  que separa visiblemente palabras en una línea.
  
  Las definiciones siguientes son equivalentes: <info>true</info> para caracteres de Unicode White_Space excepto
  para «controles de espaciado vertical», siendo estos últimos los siguientes caracteres: U+000A
  (LF) U+000B (VT) U+000C (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS) <info>true</info> para U+0009
  (TAB) y caracteres con categoría general "Zs" (separadores espaciales) excepto Zero Width Space
  (ZWSP, U+200B).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter «en blanco» o de «espacio horizontal», <info>false</info> si
        no.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>


id: IntlChar::iscntrl
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de control
  
  Determina si el punto de código especificado es un carácter de control.
  
  Un carácter de control es uno de los siguientes: Carácter de control de 8 bits de ISO
  (U+0000..U+001f and U+007f..U+009f)<info>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</info>
  (Cc)<info>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</info> (Cf)<info>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</info>
  (Zl)<info>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</info> (Zp)

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de control, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isprint()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::isdefined
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código está definido
  
  Determina si el punto de código especificado está «definido», lo que normalmente significa que
  tiene asignado un caráter.
  
  <info>true</info> para las catergorías generales distintas de "Cn" (otros, no asignado).
  
  Observe que los puntos de código que no son un carácter (p.ej., U+FDD0) no están «definidos» (son
  Cn), mientras que los puntos de código sustitutos están «definidos» (Cs).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter definido, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>


id: IntlChar::isdigit
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de dígito
  
  Determina si el punto de código especificado es un carácter de dígito.
  
  <info>true</info> para caracteres con categoría general "Nd" (números de dígito decimal). Desde Unicode 4, esto
  es lo mismo que probar el Numeric_Type de Decimal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de dígito, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isxdigit()</strong>


id: IntlChar::isgraph
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un caráter gráfico
  
  Determina si el punto de código especificado es un carácter «graphic» (imprimible, excluyendo los
  espacios).
  
  <info>true</info> para todos los caracteres excepto aquellos con categorías generales "Cc" (códigos de
  control), "Cf" (controles de formato), "Cs" (sustitutos), "Cn" (sin asignar), y "Z" (separadores).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un caráter «gráfico», <info>false</info> si no.


id: IntlChar::islower
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es una letra minúscula
  
  Determina si el punto de código especificado tiene la categoría general "Ll" (letra minúscula).
  
  Este método erra con algunos caracteres que tambíen son minúscula pero tienen un valor diferente
  de categoría general. Para incluirlos, use <strong>IntlChar::isULowercase()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es una letra minúscula de Ll, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>


id: IntlChar::isprint
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter imprimible
  
  Determina si el punto de código especificado es un carácter imprimible.
  
  <info>true</info> para categorías generales distintas de "C" (controles).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter imprimible, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::ispunct
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de puntuación
  
  Determina si el punto de código especificado es un carácter de puntuación.
  
  <info>true</info> para caracteres con categoría general "P" (puntuación).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de puntuación, <info>false</info> si no.


id: IntlChar::isspace
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es un carácter de espacio
  
  Determina si el carácter especificado es o no un carácter de espacio.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter de espacio, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::istitle
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código es una letra titular
  
  Determina si el punto de código especificado es una letra titular.
  
  <info>true</info> para la categoría general "Lt" (letra titular).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es una letra titular, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::totitle()</strong>


id: IntlChar::isupper
type: function
doc:
<comment>Description:</comment>
  Comprobar si un punto de código tiene la categoría general "Lu" (letra mayúscula)
  
  Determina si el punto de código especificado tiene la categoría general "Lu" (letra mayúscula).
  
  Este método erra con algunos caracteres que tambíen son mayúscula pero tienen un valor diferente
  de categoría general. Para incluirlos, use <strong>IntlChar::isUUppercase()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es una letra mayúscula de Lu, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>


id: IntlChar::isxdigit
type: function
doc:
<comment>Description:</comment>
  Comprobar si el punto de código es un dígito hexadecimal
  
  Determina si el punto de código especificado es un dígito hexadecimal.
  
  <info>true</info> para caracteres con la categoría general "Nd" (números de dígito decimal) así como con las
  letras latinas a-f y A-F tanto en ASCII como en ASCII de ancho completo. (Esto es, para letras con
  puntos de código 0041..0046, 0061..0066, FF21..FF26, FF41..FF46).
  
  Esto equivale a <return>IntlChar::digit($codepoint, 16) &gt;= 0</return>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$codepoint</strong> es un carácter hexadecimal, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::ord
type: function
doc:
<comment>Description:</comment>
  Devolver el valor del punto de código de Unicode de un carácter
  
  Devuelve el valor del punto de código de Unicode del carácter dado.
  
  Esta función complementa a <strong>IntlChar::chr()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$character</strong>  Un carácter Unicode.

<comment>Return:</comment>
  <info>int</info>  Devuelve el valor del punto de código de Unicode, como integer.

<comment>See Also:</comment>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>IntlChar::chr()</strong>
   * <strong>ord()</strong>


id: IntlChar::tolower
type: function
doc:
<comment>Description:</comment>
  Convertir a minúsculas un carácter Unicode
  
  Se hace corresponder el carácter dado con su equivalente en minúsculas. Si el carácter no tiene
  dicho equivalente, se devuelve el carácter en sí.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el Simple_Lowercase_Mapping del punto de código, si lo hubiera; de lo contrario
         devuelve el punto de código en sí.
         
         El tipo devuelto será <info>integer</info> a menos que el punto de código se pase como un <info>string</info> UTF-8,
         en cuyo caso será devuelto un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::totitle()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_strtolower()</strong>


id: IntlChar::totitle
type: function
doc:
<comment>Description:</comment>
  Convertir un carácter Unicode a letra titular
  
  Se hace corresponder el carácter dado con su equivalente de letra titular. Si el carácter no tiene
  dicho equivalente, se devuelve el carácter en sí.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el Simple_Titlecase_Mapping del punto de código, si lo hubiera; de lo contrario
         devuelve el punto de código en sí.
         
         El tipo devuelto será <info>integer</info> a menos que el punto de código se pase como un <info>string</info> UTF-8,
         en cuyo caso será devuelto un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_convert_case()</strong>


id: IntlChar::toupper
type: function
doc:
<comment>Description:</comment>
  Convertir a mayúsculas un carácter Unicode
  
  Se hace corresponder el carácter dado con su equivalente en mayúsculas. Si el carácter no tiene
  dicho equivalente, se devuelve el carácter en sí.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  El valor de tipo <info>integer</info> del punto de código (p.ej. <return>0x2603</return> para U+2603
                     SNOWMAN), o el carácter codificado como un <info>string</info> UTF-8 (p.ej. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el Simple_Uppercase_Mapping del punto de código, si lo hubiera; de lo contrario
         devuelve el punto de código en sí.
         
         El tipo devuelto será <info>integer</info> a menos que el punto de código se pase como un <info>string</info> UTF-8,
         en cuyo caso será devuelto un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::totitle()</strong>
   * <strong>mb_strtoupper()</strong>


id: IntlCodePointBreakIterator
type: class
doc:
<comment>Description:</comment>
  Este iterador de ruptura identifica los límites entre puntos de código de UTF-8.


id: IntlCodePointBreakIterator::getLastCodePoint
type: function
doc:
<comment>Description:</comment>
  Obtener el último punto de código ignorado después de que el iterdor avance o retroceda
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlDateFormatter
type: class
doc:
<comment>Description:</comment>
  Date Formatter es una clase concreta que permite el formateo/procesamiento dependiente de la
  configuración regional de fechas utilizando cadenas de patrones y/o patrones enlatados.
  
  Esta clase representa la funcionalidad de formateo de fechas de ICU.  Permite a los usuarios
  mostrar fechas en un formato regional o convertir cadenas a valores de fecha de PHP utilizando
  cadenas de patrones y/o patrones enlatados.


id: IntlDateFormatter::FULL
type: constant
doc:
<comment>Description:</comment>
  Estilo completamente especificado (Tuesday, April 12, 1952 AD o 3:30:42pm PST)


id: IntlDateFormatter::SHORT
type: constant
doc:
<comment>Description:</comment>
  El estilo más abreviado, sólo información esencial (12/13/52 or 3:30pm)


id: IntlDateFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un formateador de fechas
  
  Estilo orientado a objetos
  
  Estilo orientado a objetos (constructor)
  
  Estilo por procedimientos
  
  Crear un formateador de fechas.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>    Configuración regional a usar al formatear o procesar, o <info>null</info> para usar el
                     valor especificado en el ajuste ini intl.default_locale.
  <info>int</info>     <strong>$datetype</strong>  Tipo de fecha a usar (<info>none</info>, <info>short</info>, <info>medium</info>, <info>long</info>, <info>full</info>). Es una de las contantes
                     de IntlDateFormatter. También puede ser <info>null</info>, en cuyo caso se usará el tipo de
                     fecha predeterminado de ICU.
  <info>int</info>     <strong>$timetype</strong>  Tipo de hora a usar (<info>none</info>, <info>short</info>, <info>medium</info>, <info>long</info>, <info>full</info>). Es una de las contantes
                     de IntlDateFormatter. También puede ser <info>null</info>, en cuyo caso se usará el tipo de
                     hora predeterminado de ICU.
  <info>mixed</info>   <strong>$timezone</strong>  ID de la zona horaria. El predeterminado (y el usado si se proporciona <info>null</info>) es
                     el devuelto por <strong>date_default_timezone_get()</strong> o, si es aplicable, aquel del
                     objeto <class>IntlCalendar</class> pasado al parámetro <strong>$calendar</strong>. Este ID debe ser un
                     identificador válido en la base de datos de ICU o un ID que represente un
                     índice explícito, como <return>GMT-05:30</return>.
                     
                     También puede ser un objeto <class>IntlTimeZone</class> o <class>DateTimeZone</class>.
  <info>mixed</info>   <strong>$calendar</strong>  Calendario a usar al formatear o procesar. El valor predeteminado es <info>null</info>, el
                     cual corresponde a <info>IntlDateFormatter::GREGORIAN</info>. También puede ser una de las
                     constantes de calendario de IntlDateFormatter o un <class>IntlCalendar</class>. Cualquier
                     objeto <class>IntlCalendar</class> pasado será clonado; no será cambiado por
                     <class>IntlDateFormatter</class>. Esto determinará el tipo de calendario usado (gregoriano,
                     islámico, persa, etc.) y, si se proporciona <info>null</info> al parámetro <strong>$timezone</strong>,
                     también la zona horaria usada.
  <info>string</info>  <strong>$pattern</strong>   Patrón opcional a usar al formatear o procesar. Los posibles patrones están
                     documentados en
                     https://unicode-org.github.io/icu/userguide/format_parse/datetime/.

<comment>Return:</comment>
  <info>IntlDateFormatter</info>  El <class>IntlDateFormatter</class> creado o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::format
type: function
doc:
<comment>Description:</comment>
  Formatear el valor fecha/hora como una cadena
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Formatea el valor del instante como una cadena.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>    El recurso del formateador de fechas.
  <info>mixed</info>              <strong>$value</strong>  El valor a formatear. Puede ser un objeto <class>DateTime</class>, un objeto
                             <class>IntlCalendar</class>, un tipo <info>numeric</info> que representa un número (posiblemente
                             fraccionario) de segundos desde la época o un <info>array</info> en el formato
                             generado por <strong>localtime()</strong>.
                             
                             Si se proporciona un objeto <class>DateTime</class> o <class>IntlCalendar</class>, su zona horaria no
                             se considera. El objeto será formateado usando la zona horaria
                             configurada del formateador. Si se quiere usar la zona horaria del
                             objeto a formatear, <strong>IntlDateFormatter::setTimeZone()</strong> debe ser invocado
                             antes con la zona horaria del objeto. Alternativamente, la función
                             estática <strong>IntlDateFormatter::formatObject()</strong> podría usarse en su lugar.

<comment>Return:</comment>
  <info>string</info>  La cadena formateada o, si ocurrión un error, <info>false</info>.

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>
   * <strong>datefmt_format_object()</strong>


id: IntlDateFormatter::formatObject
type: function
doc:
<comment>Description:</comment>
  Formatea un objeto
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Esta función permite formatear un objeto <class>IntlCalendar</class> o <class>DateTime</class> sin crear primero explícitamente
  un objeto <class>IntlDateFormatter</class>.
  
  El objeto <class>IntlDateFormatter</class> temporal que se creará tomará la zona horaria del objeto pasado. La
  base de datos de zonas horarias incluida con PHP no se usara; se usará en su lugar la de ICU. El
  identificador de zona horaria usado en objetos <class>DateTime</class> debe, por lo tanto, existir también en la
  base de datos de ICU.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Un objeto de tipo <class>IntlCalendar</class> o <class>DateTime</class>. Se usrará la información de la zona
                   horaria del objeto.
  <info>mixed</info>   <strong>$format</strong>  Cómo formatear la fecha/hora. Puede ser un <info>array</info> con dos elementos (el primero el
                   estilo de fecha, y luego el estilo de la hora, siendo ambos una de las constantes
                   <info>IntlDateFormatter::NONE</info>, <info>IntlDateFormatter::SHORT</info>, <info>IntlDateFormatter::MEDIUM</info>,
                   <info>IntlDateFormatter::LONG</info>, <info>IntlDateFormatter::FULL</info>), un <info>long</info> con el valor de una de
                   estas constantes (en cuyo caso se usará tanto para la hora como para la fecha) o
                   un <info>string</info> con el formato descrito en la documentación de ICU. Si es <info>null</info>, se
                   utilizará el estilo predeterminado.
  <info>string</info>  <strong>$locale</strong>  La configuración regional a usar, o <info>null</info> para usar la predeterminada.

<comment>Return:</comment>
  <info>string</info>  Un string con resultados  o <info>false</info> en caso de error.


id: IntlDateFormatter::getCalendar
type: function
doc:
<comment>Description:</comment>
  Obtener el tipo de calendario usado por el objeto IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor

<comment>Return:</comment>
  <info>int</info>  El tipo de calendario a usar por el formateador. <info>IntlDateFormatter::TRADITIONAL</info> o
       <info>IntlDateFormatter::GREGORIAN</info>.

<comment>See Also:</comment>
   * <strong>datefmt_get_calendar_object()</strong>
   * <strong>datefmt_set_calendar()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getCalendarObject
type: function
doc:
<comment>Description:</comment>
  Obtener una copia del objeto calendario del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene una copia del objeto calendario usado internamente por este formateador. Este calendario
  tendrá un tipo (como gregorian, japanese, buddhist, roc, persian, islamic, etc.) y una zona
  horaria que coincide con el tipo y la zona horaria usada por el formateador. La fecha/hora del
  objeto está sin especificar.

<comment>Return:</comment>
  <info>IntlCalendar</info>  Una copia del calendario interno usado por este formateador.

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getCalendar()</strong>
   * <strong>IntlDateFormatter::setCalendar()</strong>
   * <class>IntlCalendar</class>


id: IntlDateFormatter::getDateType
type: function
doc:
<comment>Description:</comment>
  Obtener el tipo de fecha usada por un formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve el tipo de fecha usada por el formateador.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor.

<comment>Return:</comment>
  <info>int</info>  El valor actual del tipo de fecha del formateador.

<comment>See Also:</comment>
   * <strong>datefmt_get_timetype()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el código del error de la última operación
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el código del error de la última operación. Devuelve el código del error de la última
  operación de formatero de números.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formateador.

<comment>Return:</comment>
  <info>int</info>  El código del error, uno de los valores de UErrorCode. El valor inicial es U_ZERO_ERROR.

<comment>See Also:</comment>
   * <strong>datefmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: IntlDateFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el texto del error de la última operación
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el texto del error de la última operación.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formateador.

<comment>Return:</comment>
  <info>string</info>  La descripción del último error.

<comment>See Also:</comment>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: IntlDateFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Obtener la configuración regional usada por un formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene la configuración regional usada por el formateador.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>   El recurso del formatedor.
  <info></info>                   <strong>$hich</strong>  Se puede elegir entre una configuración regional válida o real (
                            <info>Locale::VALID_LOCALE</info>, <info>Locale::ACTUAL_LOCALE</info>, respectivamente). La
                            predeterminada el la configuración regional real.

<comment>Return:</comment>
  <info>string</info>  La configuración regional de este formateador o 'false' en caso de error

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


id: IntlDateFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Obtener el patrón utilizado por un formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener el patrón utilizado por el formateador.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor.

<comment>Return:</comment>
  <info>string</info>  La cadena del patrón que está siendo usada para formatear/procesar.

<comment>See Also:</comment>
   * <strong>datefmt_set_pattern()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getTimeType
type: function
doc:
<comment>Description:</comment>
  Obtener el tipo de hora usada por un formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve el tipo de hora usada por el formateador.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor.

<comment>Return:</comment>
  <info>int</info>  El valor actual del tipo de fecha del formateador.

<comment>See Also:</comment>
   * <strong>datefmt_get_datetype()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getTimeZone
type: function
doc:
<comment>Description:</comment>
  Obtener la zona horaria del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un objeto <class>IntlTimeZone</class> que representa la zona horaria que usará este objeto para
  formatear las fechas y las horas. Al formatear objetos <class>IntlCalendar</class> y <class>DateTime</class> con este
  <class>IntlDateFormatter</class>, la zona horaria usada será la devuelta por este método, no la asociada con los
  objetos que se están formateando.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  El objeto <class>IntlTimeZone</class> asociado  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getTimeZoneId()</strong>
   * <strong>IntlDateFormatter::setTimeZone()</strong>
   * <class>IntlTimeZone</class>


id: IntlDateFormatter::getTimeZoneId
type: function
doc:
<comment>Description:</comment>
  Obtener el ID de la zona horario usada por un formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el ID de la zona horario usada por un formateador de IntlDateFormatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor.

<comment>Return:</comment>
  <info>string</info>  Una cadena con el ID de la zona horaria usada por este formateador.

<comment>See Also:</comment>
   * <strong>datefmt_set_timezone_id()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::isLenient
type: function
doc:
<comment>Description:</comment>
  Obtener la tolerancia usada por un formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Comprueba si el analizador es estricto o tolerante al interpretar las entradas que no coinciden
  exactamente con el patrón.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  El recurso del formatedor.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el analizador es tolerante, <info>false</info> si es estricto. Por omisión, el analizador es
        tolerante.

<comment>See Also:</comment>
   * <strong>datefmt_set_lenient()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::localtime
type: function
doc:
<comment>Description:</comment>
  Convertir una cadena en un valor de marca de tiempo basado en un campo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Convierte la cadena $value a un valor de instante basado en un campo (un array de varios campos),,
  empezando en la posición dada por $parse_pos y consumiendo tanto del valor de entrada como sea
  posible.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>       El recurso del formateador.
  <info>string</info>             <strong>$value</strong>     La cadena que convertir a un instante
  <info>int</info>                <strong>$position</strong>  La posición a la cual empezar la conversión de $value (basado en
                                cero). Si no ocurre ningún error antes de que $value sea consumido,
                                $parse_pos contendrá -1, de otro modo contendrá la posición en la
                                que finaliza la conversión (ocurrido el error). Si $parse_pos &gt;
                                strlen($value), la conversión falla automáticamente.

<comment>Return:</comment>
  <info>array</info>  Un array Localtime compatible array of integers  : contains 24 hour clock value in tm_hour
         field

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Convertir una cadena en un valor de marca de tiempo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Convierte la cadena $value a un valor de marca de tiempo incremental, empezando en la posición
  dada por $parse_pos y consumiendo tanto del valor de entrada como sea posible.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>       El recurso del formateador
  <info>string</info>             <strong>$value</strong>     La cadena que convertir a un instante
  <info>int</info>                <strong>$position</strong>  La posición a la cual empezar la conversión de $value (basado en
                                cero). Si no ocurre ningún error antes de que $value sea consumido,
                                $parse_pos contendrá -1, de otro modo contendrá la posición en la
                                que finaliza la conversión (ocurrido el error). Esta variable
                                contendrá la posición final si la converión falla. Si $parse_pos
                                &gt; strlen($value), la conversión falla automáticamente.

<comment>Return:</comment>
  <info>int</info>  El valor de la marca de tiempo, o <info>false</info> si el valor no se puede analizar.

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_localtime()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::setCalendar
type: function
doc:
<comment>Description:</comment>
  Establecer el tipo de calendario usado por el formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el calendario o el tipo de calendario usado por el formateador.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>    El recurso del formatedor
  <info>mixed</info>              <strong>$which</strong>  Puede ser: el tipo de calendario a usar (el predeterminado es
                             <info>IntlDateFormatter::GREGORIAN</info>, el cual también se usa si se especifica
                             <info>null</info>) o un objeto <class>IntlCalendar</class>.
                             
                             Cualquier objeto <class>IntlCalendar</class> pasado será clonado; no se realizará
                             ninguna modificación al objeto del argumento.
                             
                             La zona horaria del formateador se mantendrá únicamente si no se pasa
                             un objeto <class>IntlCalendar</class>, de otro modo la nuevo zona horaria será aquella
                             del objeto pasado.

<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>
   * <strong>datefmt_get_calendar()</strong>
   * <strong>datefmt_get_calendar_object()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setLenient
type: function
doc:
<comment>Description:</comment>
  Establecer la tolerancia del analizador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Define si el analizador es estricto o tolerante al interpretar salidas que no coinciden
  exactamente con el patrón. Habilitar el análisis tolerante permite al analizador aceptar patrones
  de fecha u hora defectuosos, procesando lo más posible para obtener un valor. No se aceptan los
  espacios extra, tokens no reconocidos, o valores no válidos ("30 de febrero").

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>      El recurso del formatedor.
  <info>bool</info>               <strong>$lenient</strong>  Establecer si el analizador es tolerante o no, por defecto es <info>false</info>
                               (tolerante).

<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>
   * <strong>datefmt_is_lenient()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Establecer el patrón utilizado por el formateador de IntlDateFormatter
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el patrón utilizado por el formateador de IntlDateFormatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>      El recurso del formatedor.
  <info>string</info>             <strong>$pattern</strong>  La nueva cadena de patrón a usar. Los patrones posibles están
                               documentados es
                               https://unicode-org.github.io/icu/userguide/format_parse/datetime/.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Las cadenas mal formateadas son
        normalmente la causa del fallo.

<comment>See Also:</comment>
   * <strong>datefmt_get_pattern()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setTimeZone
type: function
doc:
<comment>Description:</comment>
  Establece la zona horaria del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece la zona horaria que se usará al formatear fechas u horas con este objeto.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$zone</strong>  La zona horaria a usar para este formateador. Puede ser especificada en las
                siguientes formas:
                
                <info>null</info>, en cuyo caso se usará la zona horaria predeterminada, tal como está
                especificada en el ajuste ini date.timezone o a través de la función
                <strong>date_default_timezone_set()</strong> y como es devuelto por <strong>date_default_timezone_get()</strong>.
                
                Un <class>IntlTimeZone</class>, que se usará directamente.
                
                Un <class>DateTimeZone</class>. Su identificador será extraido y se creará un objeto de zona
                horaria de ICU; la zona horaria será proporcionada por la base de datos de ICU, no
                por la de PHP.
                
                Un <info>string</info>, que debería ser un identificador de zona horaria de ICU válido. Véase
                <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Los índices puros como <return>"GMT+08:30"</return>
                también se aceptan.

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

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getTimeZone()</strong>


id: IntlException
type: class
doc:
<comment>Description:</comment>
  Esta clase se usa para generar excepciones ocurridos dentro de las funciones de intl. Tales
  excepciones se generan únicamente cuando intl.use_exceptions está habilitado.


id: IntlIterator
type: class
doc:
<comment>Description:</comment>
  Esta clase representa objetos iteradores a lo largo de la extensión intl siempre que el iterador
  no pueda ser identificado con ningún otro objeto proporcionado por la extensión. El objeto
  iterador diferente usado internamente por el  constructor <return>foreach</return>  solamente se puede obtener (en
  lo que concierne aquí) desde objetos, por lo que los objetos de esta clase sirven al propósito de
  proporcionar el gancho a través del cual se puede obtener este objeto interno. Como ventaja, esta
  clase también implementa la interfaz <class>Iterator</class>, permitiendo que se pueda navegar a través de la
  colección de valores usando los métodos definidos en esa interfaz. Tanto estos métodos como los
  objetos iteradores internos proporcionados a <return>foreach</return> se apoyan en el mismo estado (p.ej. la
  posición del iterador y su valor actual).
  
  Las subclases podrían proporcionar una funcionalidad más rica.


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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene la clave actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlIterator::next
type: function
doc:
<comment>Description:</comment>
  Adelanta hasta el siguiente elemento
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si la posición actual es válida
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlPartsIterator
type: class
doc:
<comment>Description:</comment>
  Los objetos de esta clase se pueden obtener desde objetos <class>IntlBreakIterator</class>. Mientras que los
  iteradores de ruptura proporcionan una secuencia de posiciones límite cuando son recorridos, los
  objetos <class>IntlPartsIterator</class> proporcionan, como ventaja, los fragmentos de texto comprendidos entre
  dos límites sucesivos.
  
  Las claves podrían representar el índice del límite izquierdo, límite derecho, o podrían
  simplemente representar la secuencia de enteros no negativos. Véase
  <strong>IntlBreakIterator::getPartsIterator()</strong>.


id: IntlPartsIterator::getBreakIterator
type: function
doc:
<comment>Description:</comment>
  Obtener un IntlBreakIterator respaldando este iterador de partes
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlRuleBasedBreakIterator
type: class
doc:
<comment>Description:</comment>
  Una subclase de <class>IntlBreakIterator</class> que encapsula iteradores de ruptura de ICU cuyo comportamiento
  se especifica usando un conjunto de reglas. Este es el tipo más común de iteradores de ruptura.
  
  Estas reglas están descritas en laGuía de usuario de análisis de límites de ICU.


id: IntlRuleBasedBreakIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un iterador desde un conjunto de reglas
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info></info>  <strong>$"rules"</strong>        
  <info></info>  <strong>$"areCompiled"</strong>  


id: IntlRuleBasedBreakIterator::getBinaryRules
type: function
doc:
<comment>Description:</comment>
  Obtener la forma binaria de las reglas compiladas
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlRuleBasedBreakIterator::getRuleStatus
type: function
doc:
<comment>Description:</comment>
  Obtener el mayor valor de estado de las reglas de ruptura que determinaron la posición de ruptura
  actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlRuleBasedBreakIterator::getRuleStatusVec
type: function
doc:
<comment>Description:</comment>
  Obtener los valores de estado de las reglas de ruptura que determinaron la posición de ruptura
  acutal
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlRuleBasedBreakIterator::getRules
type: function
doc:
<comment>Description:</comment>
  Obtener el conjunto de reglas empleado para crear este objeto
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: IntlTimeZone::countEquivalentIDs
type: function
doc:
<comment>Description:</comment>
  Obtener el número de ID del grupo de equivalencias que incluye el ID dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>integer</info>  


id: IntlTimeZone::createDefault
type: function
doc:
<comment>Description:</comment>
  Crear una nueva copia de la zona horaria predeterminada para este host
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::createEnumeration
type: function
doc:
<comment>Description:</comment>
  Obtener una enumeración de ID de zonas horarias asociados al
    país o í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>$countryOrRawOffset</strong>  

<comment>Return:</comment>
  <info>IntlIterator</info>  


id: IntlTimeZone::createTimeZone
type: function
doc:
<comment>Description:</comment>
  Crear un objeto de zona horaria para el ID dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::createTimeZoneIDEnumeration
type: function
doc:
<comment>Description:</comment>
  Get an enumeration over system time zone IDs with the given filter conditions
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>int</info>          <strong>$type</strong>       
  <info>string|null</info>  <strong>$region</strong>     
  <info>int|null</info>     <strong>$rawOffset</strong>  

<comment>Return:</comment>
  <info>IntlIterator|false</info>  Returns <class>IntlIterator</class> o <info>false</info> en caso de error.


id: IntlTimeZone::fromDateTimeZone
type: function
doc:
<comment>Description:</comment>
  Crear un objeto de zona horaria desde DateTimeZone
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$zoneId</strong>  

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::getCanonicalID
type: function
doc:
<comment>Description:</comment>
  Obtener el ID canónico de la zona horaria del sistema o el ID normalizado de la zona horaria
  personalizada para el ID de zona horaria dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId</strong>      
  <info>bool</info>    <strong>$isSystemID</strong>  

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


id: IntlTimeZone::getDSTSavings
type: function
doc:
<comment>Description:</comment>
  Obtener la cantidad de tiempo a añadir a la hora local estándar para obtener la hora local actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: IntlTimeZone::getDisplayName
type: function
doc:
<comment>Description:</comment>
  Obtener un nombre de esta zona horaria apto para la presentación al usuario
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>bool</info>     <strong>$isDaylight</strong>  
  <info>integer</info>  <strong>$style</strong>       
  <info>string</info>   <strong>$locale</strong>      

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


id: IntlTimeZone::getEquivalentID
type: function
doc:
<comment>Description:</comment>
  Obtener un ID del grupo de equivalencias que incluya el ID dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>   <strong>$zoneId</strong>  
  <info>integer</info>  <strong>$index</strong>   

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


id: IntlTimeZone::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el último código de error del objeto
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: IntlTimeZone::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el último mensaje de error del objeto
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: IntlTimeZone::getGMT
type: function
doc:
<comment>Description:</comment>
  Crear una zona horaria GMT (UTC)
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::getID
type: function
doc:
<comment>Description:</comment>
  Obtener el ID de la zona horaria
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: IntlTimeZone::getIDForWindowsID
type: function
doc:
<comment>Description:</comment>
  Translate a Windows timezone into a system timezone
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Translates a Windows timezone (e.g. "Pacific Standard Time") into a system timezone (e.g.
  "America/Los_Angeles").
  
  This function requires ICU version ≥ 52.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>       <strong>$timezoneId</strong>  
  <info>string|null</info>  <strong>$region</strong>      

<comment>Return:</comment>
  <info>string|false</info>  Returns the system timezone o <info>false</info> en caso de error.

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


id: IntlTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Obtener la zona horaria sin tratar y el índice GMT para el momento dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>float</info>    <strong>$date</strong>       
  <info>bool</info>     <strong>$local</strong>      
  <info>integer</info>  <strong>$rawOffset</strong>  
  <info>integer</info>  <strong>$dstOffset</strong>  

<comment>Return:</comment>
  <info>integer</info>  


id: IntlTimeZone::getRawOffset
type: function
doc:
<comment>Description:</comment>
  Obtener el índice GMT sin tratar (antes de tomar en cuenta el horario de verano)
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: IntlTimeZone::getRegion
type: function
doc:
<comment>Description:</comment>
  Get the region code associated with the given system time zone ID
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>string|false</info>  Return region o <info>false</info> en caso de error.


id: IntlTimeZone::getTZDataVersion
type: function
doc:
<comment>Description:</comment>
  Obtener la versión de los datos de zonas horarias actualmente usada por ICU
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: IntlTimeZone::getUnknown
type: function
doc:
<comment>Description:</comment>
  Get the "unknown" time zone
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  Returns <class>IntlTimeZone</class> or <info>null</info> on failure.


id: IntlTimeZone::getWindowsID
type: function
doc:
<comment>Description:</comment>
  Translate a system timezone into a Windows timezone
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Translates a system timezone (e.g. "America/Los_Angeles") into a Windows timezone (e.g. "Pacific
  Standard Time").
  
  This function requires ICU version ≥ 52.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>string|false</info>  Returns the Windows timezone o <info>false</info> en caso de error.

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


id: IntlTimeZone::hasSameRules
type: function
doc:
<comment>Description:</comment>
  Comprobar si esta zona horaria tiene las mismas reglas e índices que otra
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>IntlTimeZone</info>  <strong>$otherTimeZone</strong>  

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


id: IntlTimeZone::toDateTimeZone
type: function
doc:
<comment>Description:</comment>
  Convertir a un objeto DateTimeZone
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>DateTimeZone</info>  


id: IntlTimeZone::useDaylightTime
type: function
doc:
<comment>Description:</comment>
  Comprobar si esta zona horaria utiliza el horario de verano
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: Iterator
type: class
doc:
<comment>Description:</comment>
  Interfaz para iteradores externos u objetos que pueden ser iterados internamente por sí mismos.


id: Iterator::current
type: function
doc:
<comment>Description:</comment>
  Devuelve el elemento actual
  
  Devuelve el elemento actual.

<comment>Return:</comment>
  <info>mixed</info>  Puede devolver cualquier tipo.


id: Iterator::key
type: function
doc:
<comment>Description:</comment>
  Devuelve la clave del elemento actual
  
  Devuelve la clave del elemento actual.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>scalar</info> en caso de éxito, o <info>null</info> en caso de error.


id: Iterator::next
type: function
doc:
<comment>Description:</comment>
  Avanza al siguiente elemento
  
  Avanza la posición actual al siguiente elemento.
  
  El método es llamado después de cada foreach loop.

<comment>Return:</comment>
  <info>void</info>  El valor devuelto es ignorado.


id: Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobine la Iterator al primer elemento
  
  Rebobina de nuevo al primer elemento de la Iterator.
  
  Este es el primer método llamado cuando se inicia un foreach bucle. No va a ser ejecutado despues
  foreach bucle.

<comment>Return:</comment>
  <info>void</info>  Cualquier valor devuelto se pasa por alto.


id: Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si la posición actual es válido
  
  Este método se llama después de Iterator::rewind y Iterator::next para comprobar si la posición
  actual es válido.

<comment>Return:</comment>
  <info>bool</info>  El valor de retorno se debe fundir a <info>bool</info> y luego evaluar. Devuelve <info>true</info> en caso de éxito o
        <info>false</info> en caso de error.


id: IteratorAggregate::getIterator
type: function
doc:
<comment>Description:</comment>
  Recuperar un Iterator externo
  
  Devuelve un iterador externo.

<comment>Return:</comment>
  <info>Traversable</info>  Una instancia de un objeto que implementa <class>Iterator</class> o <class>Traversable</class>


id: IteratorIterator
type: class
doc:
<comment>Description:</comment>
  Esta envoltura de iteradores permite la conversión de todo aquello que es Traversable a un
  iterador. Es importante comprender que la mayoría de las clases que no implementan  iteradores, lo
  más probable es que no permitan todas las características del iterador. Si es así, deberían
  proporcionarse técnicas para evitar un uso indebido, de lo contrario se pueden esperar excepciones
  o errores fatales.


id: IteratorIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un iterador de cualquier cosa que se pueda recorrer
  
  Crea un iterador de cualquier cosa que se pueda recorrer.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  El iterador recorrible.

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

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


id: IteratorIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtener el valor actual
  
  Obtiene el valor actual del elemento.

<comment>Return:</comment>
  <info>mixed</info>  El valor del elemento actual.

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


id: IteratorIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Obtener el iterador interno
  
  Obtiene el iterador interno.

<comment>Return:</comment>
  <info>Traversable</info>  El iterador interno tal y como se pasó a IteratorIterator::__construct.

<comment>See Also:</comment>
   * <class>Iterator</class>
   * <class>OuterIterator</class>


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

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

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


id: IteratorIterator::next
type: function
doc:
<comment>Description:</comment>
  Avanzar al siguiente elemento
  
  Avanza al siguiente elemento.

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

<comment>See Also:</comment>
   * IteratorIterator::rewind
   * IteratorIterator::valid


id: IteratorIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobinar al primer elemento
  
  Rebobinar al primer elemento.

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

<comment>See Also:</comment>
   * IteratorIterator::next
   * IteratorIterator::valid


id: IteratorIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprobar si el iterador es válido
  
  Comprueba si el iterador es válido.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el iterador es válido, <info>false</info> en caso contrario

<comment>See Also:</comment>
   * <strong>iterator_count()</strong>
   * IteratorIterator::current


id: JSON_BIGINT_AS_STRING
type: constant
doc:
<comment>Description:</comment>
  Codifica integer grandes como su valor del string original. Disponible desde PHP 5.4.0.


id: JSON_ERROR_CTRL_CHAR
type: constant
doc:
<comment>Description:</comment>
  Error del carácter de control, posiblemente se ha codificado de forma incorrecta. Disponible desde
  PHP 5.3.0.


id: JSON_ERROR_DEPTH
type: constant
doc:
<comment>Description:</comment>
  Se ha excedido la profundidad máxima de la pila. Disponible desde PHP 5.3.0.


id: JSON_ERROR_INF_OR_NAN
type: constant
doc:
<comment>Description:</comment>
  El valor pasado a <strong>json_encode()</strong> incluye <info>NAN</info> o <info>INF</info>. Si se proporcionó la opción
  <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, se codificará <return>0</return> en el lugar de estos números especiales.
  
  Esta constante está disponible a partir de PHP 5.5.0.


id: JSON_ERROR_RECURSION
type: constant
doc:
<comment>Description:</comment>
  El objeto o array pasado a <strong>json_encode()</strong> incluye referencias recursivas y no se puede codificar.
  Si se proporcionó la opción <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, se codificará <info>null</info> en el lugar de la
  referencia recursiva.
  
  Esta constante está disponible a partir de PHP 5.5.0.


id: JSON_ERROR_STATE_MISMATCH
type: constant
doc:
<comment>Description:</comment>
  Por desbordamiento de buffer o cuando los modos no coinciden. Disponible desde PHP 5.3.0.


id: JSON_ERROR_UNSUPPORTED_TYPE
type: constant
doc:
<comment>Description:</comment>
  Se proporcionó un valor de un tipo no admitido para <strong>json_encode()</strong>, tal como un <info>resource</info>. Si se
  proporcionó la opción <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, se codificará <info>null</info> en el lugar del valor no
  admitido.
  
  Esta constante está disponible a partir de PHP 5.5.0.


id: JSON_ERROR_UTF8
type: constant
doc:
<comment>Description:</comment>
  Caracteres UTF-8 mal formados, posiblemente codificados incorrectamente. Esta constante está
  disponible desde PHP 5.3.3.


id: JSON_FORCE_OBJECT
type: constant
doc:
<comment>Description:</comment>
  Devuelve un objeto en vez de un array cuando se usa un array no asociativo. Especialmente útil
  cuando el destinatario del resultado espera un objeto y el array está vacío. Disponible desde PHP
  5.3.0.


id: JSON_HEX_TAG
type: constant
doc:
<comment>Description:</comment>
  Todos los \< y &gt; se convierten a \u003C y \u003E. Disponible desde PHP 5.3.0.


id: JSON_NUMERIC_CHECK
type: constant
doc:
<comment>Description:</comment>
  Codifica textos numéricos como números. Disponible desde PHP 5.3.3.


id: JSON_PARTIAL_OUTPUT_ON_ERROR
type: constant
doc:
<comment>Description:</comment>
  Sustituir algunos valores no codificables en lugar de fallar. Disponible desde PHP 5.5.0.


id: JSON_PRESERVE_ZERO_FRACTION
type: constant
doc:
<comment>Description:</comment>
  Se asegura de que los valores <info>float</info> son siempre codificados como valores de punto flotante.
  Disponible desde PHP 5.6.6.


id: JSON_PRETTY_PRINT
type: constant
doc:
<comment>Description:</comment>
  Utiliza espacios en blanco para formatear los datos devueltos. Disponible desde PHP 5.4.0.


id: JSON_UNESCAPED_UNICODE
type: constant
doc:
<comment>Description:</comment>
  Codificar caracteres Unicode multibyte literalmente (por defecto es escapado como \uXXXX).
  Disponible desde PHP 5.4.0.


id: JsonSerializable
type: class
doc:
<comment>Description:</comment>
  Los objetos que implementen JsonSerializable puede personalizar su representación JSON cuando se
  codifica con <strong>json_encode()</strong>.


id: JsonSerializable::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Especifica los datos que deberían serializarse para JSON
  
  Serializa el objeto a un valor que puede ser serializado de forma nativa por <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve los datos que pueden ser serializados por <strong>json_encode()</strong>, los cuales son un valor
         de cualquier tipo distinto de <info>resource</info>.


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


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


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


id: LDAP_OPT_CLIENT_CONTROLS
type: constant
doc:
<comment>Description:</comment>
  Especifica una lista predeterminada de controles de cliente a ser procesada con cada solicitud.


id: LDAP_OPT_DEREF
type: constant
doc:
<comment>Description:</comment>
  Especifica reglas alternativas para el seguimiento de aliases en el servidor.


id: LDAP_OPT_NETWORK_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Opción para <strong>ldap_set_option()</strong> que permite ajustar el tiempo de espera de la red. (Disponible a
  partir de PHP 5.3.0)


id: LDAP_OPT_REFERRALS
type: constant
doc:
<comment>Description:</comment>
  Especifica si se deben seguir automáticamente las referencias devueltas por el servidor LDAP.


id: LDAP_OPT_SERVER_CONTROLS
type: constant
doc:
<comment>Description:</comment>
  Especifica una lista predeterminada de controles de servidor que se envía con cada solicitud.


id: LDAP_OPT_SIZELIMIT
type: constant
doc:
<comment>Description:</comment>
  Especifica el número máximo de entradas que pueden ser devueltas en una operación de búsqueda.
  
  El límite de tamaño actual de las operaciones también está delimitado por el número máximo de
  entradas de retorno configuradas en el servidor. El menor de estos dos valores es el límite de
  tamaño actual.


id: LDAP_OPT_TIMELIMIT
type: constant
doc:
<comment>Description:</comment>
  Especifica el número de segundos de espera para la búsqueda de resultados.
  
  El límite de tiempo para las operaciones también está delimitado por el tiempo máximo configurado
  en el servidor. El menor de estos dos valores es el límite de tiempo actual.


id: LDAP_OPT_X_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Especifica el número de segundos que necesita una conexión para mantenerse en estado desocupado
  antes que TCP comience a enviar pruebas de que la conexión se mantiene activa.


id: LDAP_OPT_X_KEEPALIVE_INTERVAL
type: constant
doc:
<comment>Description:</comment>
  Especifica el intervalo en segundos entre cada prueba individual donde verifica que la conexión se
  mantiene activa.


id: LDAP_OPT_X_KEEPALIVE_PROBES
type: constant
doc:
<comment>Description:</comment>
  Especifica el número máximo de pruebas de conexión activa que TCP debería enviar antes de terminar
  la conexión.


id: LDAP_OPT_X_TLS_CACERTDIR
type: constant
doc:
<comment>Description:</comment>
  Especifica la ruta del directorio que contiene los certificados de la CA (Autoridad
  Certificadora).


id: LDAP_OPT_X_TLS_CACERTFILE
type: constant
doc:
<comment>Description:</comment>
  Especifica la ruta completa del fichero de certificado de la la CA (Autoridad Certificadora).


id: LDAP_OPT_X_TLS_CRLCHECK
type: constant
doc:
<comment>Description:</comment>
  Especifica la estrategia de evaluación CRL. Esta debe ser una de las siguientes:
  <info>LDAP_OPT_X_TLS_CRL_NONE</info>,<info>LDAP_OPT_X_TLS_CRL_PEER</info>, <info>LDAP_OPT_X_TLS_CRL_ALL</info>.
  
  Esta opción es válida solamente para OpenSSL.


id: LDAP_OPT_X_TLS_CRLFILE
type: constant
doc:
<comment>Description:</comment>
  Especifica la ruta completa del fichero CRL.
  
  Esta opción es válida solamente para GnuTLS.


id: LDAP_OPT_X_TLS_DHFILE
type: constant
doc:
<comment>Description:</comment>
  Especifica la ruta completa del fichero que contiene los parámetros para el intercambio de claves
  efímero de Diffie-Hellman.
  
  Esta opción es ignorada por GnuTLS y Mozilla NSS.


id: LDAP_OPT_X_TLS_PROTOCOL_MIN
type: constant
doc:
<comment>Description:</comment>
  Especifica la versión mínima del protocolo. Esta puede ser una de las siguientes:
  <info>LDAP_OPT_X_TLS_PROTOCOL_SSL2</info>,<info>LDAP_OPT_X_TLS_PROTOCOL_SSL3</info>, <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_0</info>,
  <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_1</info>, <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_2</info>


id: LDAP_OPT_X_TLS_REQUIRE_CERT
type: constant
doc:
<comment>Description:</comment>
  Especifica el certificado que comprueba la estrategia de comprobación. Esta debe ser una de las
  siguientes: <info>LDAP_OPT_X_TLS_NEVER</info>,<info>LDAP_OPT_X_TLS_HARD</info>, <info>LDAP_OPT_X_TLS_DEMAND</info>,
  <info>LDAP_OPT_X_TLS_ALLOW</info>, <info>LDAP_OPT_X_TLS_TRY</info>.


id: LIBEXSLT_DOTTED_VERSION
type: constant
doc:
<comment>Description:</comment>
  versión de libexslt como la 1.1.17. Disponible a partir de PHP 5.1.2.


id: LIBEXSLT_VERSION
type: constant
doc:
<comment>Description:</comment>
  versión de libexslt como la 813. Disponible a partir de PHP 5.1.2.


id: LIBXML_COMPACT
type: constant
doc:
<comment>Description:</comment>
  Activa la optimización de asignación de nodos pequeños. Esto puede acelerar la aplicación sin la
  necesidad de cambiar el código.
  
  Solo disponible en Libxml &gt;= 2.6.21


id: LIBXML_HTML_NODEFDTD
type: constant
doc:
<comment>Description:</comment>
  Establece el indicador HTML_PARSE_NODEFDTD, el cual previente que se añada un tipo de documento
  predeterminado cuando no se encuentra uno.
  
  Solamente disponible en Libxml &gt;= 2.7.8 (a partir de PHP &gt;= 5.4.0)


id: LIBXML_HTML_NOIMPLIED
type: constant
doc:
<comment>Description:</comment>
  Establece el indicador HTML_PARSE_NOIMPLIED flag, el cual desactiva la adición automática de
  elementos html/body... implicados.
  
  Solamente disponible en Libxml &gt;= 2.7.7 (a partir de PHP &gt;= 5.4.0)


id: LIBXML_NOEMPTYTAG
type: constant
doc:
<comment>Description:</comment>
  Expande etiquetas vacías (por ej. de <return>\<br/&gt;</return> a <return>\<br&gt;\</br&gt;</return>)
  
  Esta opción está actualmente disponible solo en las funciones  y .


id: LIBXML_NOXMLDECL
type: constant
doc:
<comment>Description:</comment>
  Omite la declaración XML cuando se guarda un documento
  
  Solo disponible en Libxml &gt;= 2.6.21


id: LIBXML_PARSEHUGE
type: constant
doc:
<comment>Description:</comment>
  Establece la bandera XML_PARSE_HUGE, que hace más flexible cualquier límite hardcode del
  analizador. Esto afecta a los límites tales como la profundidad máxima de un documento o la
  recursión de entidades, así como los límites de tamaño de los nodos de texto.
  
  Solamente está disponible en Libxml &gt;= 2.7.0 (a partir de PHP &gt;= 5.3.2 y PHP &gt;= 5.2.12)


id: LIBXML_PEDANTIC
type: constant
doc:
<comment>Description:</comment>
  Establece el indicador XML_PARSE_PEDANTIC, el cual habilita el informe de errores pedante.
  
  Disponible a partir de PHP &gt;= 5.4.0


id: LIBXML_SCHEMA_CREATE
type: constant
doc:
<comment>Description:</comment>
  Crear nodos de valor predeterminado/fijo durante la validación del esquema XSD
  
  Solamente disponible en Libxml &gt;= 2.6.14 (a partir de PHP &gt;= 5.5.2)


id: LIBXSLT_DOTTED_VERSION
type: constant
doc:
<comment>Description:</comment>
  versión de libxslt como la 1.1.17. Disponible a partir de PHP 5.1.2.


id: LOG_AUTH
type: constant
doc:
<comment>Description:</comment>
  Mensajes de seguridad/autorización (utilice en su lugar <info>LOG_AUTHPRIV</info> en sistemas donde esa
  constante esté definida)


id: LOG_CONS
type: constant
doc:
<comment>Description:</comment>
  Si hay un error mientras se envían datos al registro del sistema, escribir directamente en la
  consola del sistema


id: LOG_ODELAY
type: constant
doc:
<comment>Description:</comment>
  (Predeterminado) Retrasar la apertura de la conexión hasta que el primer mensaje sea registrado


id: LOG_PERROR
type: constant
doc:
<comment>Description:</comment>
  Imprimir también mensajes de registro a la salida de error estándar


id: LimitIterator
type: class
doc:
<comment>Description:</comment>
  La clase <class>LimitIterator</class> permite recorrer un limitado subconjunto de elemento de un <class>Iterator</class>.


id: LimitIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un LimitIterator
  
  Construye un nuevo <class>LimitIterator</class> de un  <strong>$iterator</strong> con un determinado inicio <strong>$offset</strong> y un máximo
  <strong>$count</strong>.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El <class>Iterator</class> a limitar.
  <info>int</info>       <strong>$offset</strong>    Índice opcional de el límite.
  <info>int</info>       <strong>$count</strong>     Cuenta opcional de el límite.

<comment>Return:</comment>
  <info>unknown</info>  El nuevo <class>LimitIterator</class>.

<comment>See Also:</comment>
   * Ejemplos de LimitIterator


id: LimitIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtiene el elemento actual
  
  Obtener el elemento actual del <class>Iterator</class> interno.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el elemento actual o <info>null</info> si no hay ninguno.

<comment>See Also:</comment>
   * LimitIterator::key
   * LimitIterator::next
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::getPosition
type: function
doc:
<comment>Description:</comment>
  Devuelve la posición actual
  
  Obtiene la posición basada en cero de el <class>Iterator</class> interno.

<comment>Return:</comment>
  <info>int</info>  La posición actual.

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


id: LimitIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene la clave actual
  
  Obtiene la clave para el elemento actual en el <class>Iterator</class> interno.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve la clave de el elemento actual.

<comment>See Also:</comment>
   * LimitIterator::getPosition
   * LimitIterator::current
   * LimitIterator::next
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::next
type: function
doc:
<comment>Description:</comment>
  Mueve el iterador a la siguiente posición
  
  Mover el iterador a la siguiente posición

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

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador a un punto específicado
  
  Rebobina el iterador a un índice de inicio específicado en LimitIterator::__construct.

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

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::next
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::seek
type: function
doc:
<comment>Description:</comment>
  Mueve el apuntador interno a la posición dada
  
  Mueve el iterador a el índice específicado por <strong>$position</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  La posición para mover el apuntador interno.

<comment>Return:</comment>
  <info>int</info>  Devuelve el índice de la posición después de mover el apuntador interno.

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


id: LimitIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprobar si el elemento actual es válido
  
  Comprobar si el elemento actual es válido.

<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>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::rewind
   * LimitIterator::next
   * LimitIterator::seek


id: Locale
type: class
doc:
<comment>Description:</comment>
  Un "Locale" (Configuración Regional) es un identificador utilizado para obtener el lenguaje, la
  cultura o el comportamiento de una región específica desde una API. Las configuraciones regionales
  de PHP están organizadas e identificadas de la misma manera que las conficuraciones regionales
  CLDR usadas por ICU (y que muchos vendedores de sistemas operativos similares a Unix, el Mac,
  Java, etc., usan). Las configuraciones regionales son identificadores que usan las etiquetas de
  lenguaje RFC 4646 (que usan guiones, no guiones de subrayado) además de los identificadores más
  tradiciones que usan guiones de subrayada. A menos que se indique lo contrario, las funciones de
  esta clase son tolerante con ambos formatos.
  
  Algunos ejemplos de identificadores: en-US (Inglés, Estados Unidos)zh-Hant-TW (Chino, Tradicional,
  Taiwán)fr-CA, fr-FR (Francés para Canadá y Francia respectivamente)
  
  La clase Locale (y sus funciones procedimentales relacionadas) se usa para interactuar con los
  identificadores regionales (para verificar que un ID está bien formado, que es válido, etc.). Las
  extensiones usadas por CLDR en UAX #35 (y heredadas por ICU) son válidas y se utilizan dondequiera
  que estuvieran normalmente en ICU.
  
  Las configuraciones regionales ("locale") no pueden ser instanciadas como objetos. Todas las
  funciones y los métodos proporcionados son estáticos.
  
  La cadena nula o vacía obtiene la configuración regional "root". Ésta es equivalente a
  "en_US_POSIX" en CLDR. Las etiquetas de lenguaje (y por lo tanto los identificadores regionales)
  no son sensibles a mayúsculas-minúsculas. Existe una función de canonización para hacer que las
  mayúsculas-minúsculas coincidan con la especificación.


id: Locale::ACTUAL_LOCALE
type: constant
doc:
<comment>Description:</comment>
  Esta es la configuración regional de donde realmente proviene la información.


id: Locale::DEFAULT_LOCALE
type: constant
doc:
<comment>Description:</comment>
  Usada como parámetro regional con los métodos de varias clases de configuración regional
  afectadas, como NumberFormatter. Esta constante hace que los métodos usen la configuración
  regional predeterminada.


id: Locale::VALID_LOCALE
type: constant
doc:
<comment>Description:</comment>
  Esta es la configuración regional más específica soportada por ICU.


id: Locale::acceptFromHttp
type: function
doc:
<comment>Description:</comment>
  Intentar encontrar la mejor configuración regional basada en la cabecera "Accept-Language" de HTTP
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Intenta encontrar la configuración regional que pueda satisfacer la lista de lenguajes que es
  pedida por la cabecera "Accept-Language" de HTTP.

<comment>Param:</comment>
  <info>string</info>  <strong>$header</strong>  La cadena que contiene la cabecera "Accept-Language" de acuerdo al formato de RFC
                   2616.

<comment>Return:</comment>
  <info>string</info>  El identificador regional correspondiente.

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


id: Locale::canonicalize
type: function
doc:
<comment>Description:</comment>
  Canonizar el string de configuración regional
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: Locale::composeLocale
type: function
doc:
<comment>Description:</comment>
  Devolver un ID regional correctamente ordenado y delimitado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Deveulve un ID regional correctamente ordenado y delimitado. Las claves identifican las
  subetiquetas del ID regional en particular, y los valores son los valores de las subetiquetas
  asociadas.

<comment>Param:</comment>
  <info>array</info>  <strong>$subtags</strong>  Un array que contiene una lista de pares clave-valor, donde las claves
                   identifican las subetiquetas del ID regional en particular, y los valores son los
                   valores de las subetiquetas asociadas.  Las subetiquetas 'variant' y 'private'
                   pueden tomar un máximo de 15 valores mientras que 'extlang' puede tomar un máximo
                   de 3 valores. Está permitido que las variantes tengan un sufijo de 0-14. Por lo
                   tanto, las claves para el array de entrada pueden ser variant0, variant1,
                   ...,variant14. En el ID regional devuelto, las subetiquetas están ordenadas por
                   sufijo, resultando en variant0 seguido de variant1 seguido de variant2, etc.  Los
                   valores múltiples de 'variant', 'private' y 'extlang' se pueden especificar tanto
                   como array bajo la clave específica (p.ej. 'variant') como claves numeradas
                   múltiples (p.ej. 'variant0', 'variant1', etc.).
                   
                   Las subetiquetas 'variant' y 'private' pueden tomar un máximo de 15 valores
                   mientras que 'extlang' puede tomar un máximo de 3 valores. Está permitido que las
                   variantes tengan un sufijo de 0-14. Por lo tanto, las claves para el array de
                   entrada pueden ser variant0, variant1, ...,variant14. En el ID regional devuelto,
                   las subetiquetas están ordenadas por sufijo, resultando en variant0 seguido de
                   variant1 seguido de variant2, etc.
                   
                   Los valores múltiples de 'variant', 'private' y 'extlang' se pueden especificar
                   tanto como array bajo la clave específica (p.ej. 'variant') como claves numeradas
                   múltiples (p.ej. 'variant0', 'variant1', etc.).

<comment>Return:</comment>
  <info>string</info>  El identificador regional correspondiente.

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


id: Locale::filterMatches
type: function
doc:
<comment>Description:</comment>
  Comprobar si unfiltro de etiquetas de lenguaje coincide con una configuración regional
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Comprobar si el filtro $langtag coincide con $locale de acuerdo al algoritmo de filtración básica
  de RFC 4647.

<comment>Param:</comment>
  <info>string</info>  <strong>$langtag</strong>       La etiqueta de lenguaje a comprobar
  <info>string</info>  <strong>$locale</strong>        El rango de lenguajes con el que se realiza la comprobación
  <info>bool</info>    <strong>$canonicalize</strong>  Si es verdadero (true), los argumentos serán convertidos a su forma
                         conónica antes de la comparación.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si $locale coincide con $langtag <info>false</info> si no.

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


id: Locale::getAllVariants
type: function
doc:
<comment>Description:</comment>
  Obtener las variantes de la configuración regional de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene las variantes de la configuración regional de entrada

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional desde la que extraer las variantes

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contienen la lista de todas las subetiquetas de variantes de la configuración
         regional o <info>null</info> si no están presentes

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_region()</strong>


id: Locale::getDefault
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de la configuración regional predeterminada del identificador global
  'default_locale' de INTL
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el valor de la configuración regional predeterminada. Cuando se inicializa PHP, este valor
  se establece al valor 'intl.default_locale' en php.ini si tal valor existe, o desde la función
  uloc_getDefault() de ICU.

<comment>Return:</comment>
  <info>string</info>  La configuración regional actual en tiempo de ejecución

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


id: Locale::getDisplayLanguage
type: function
doc:
<comment>Description:</comment>
  Devolver un nombre manifiesto debidamente localizado del lenguaje de la configuración regional de
  entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nombre manifiesto debidamente localizado del lenguaje de la configuración regional de
  entrada. Si es <info>null</info> se utiliza la configuración regional predeterminada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>     La configuración regional de la que devolver un lenguaje manifiesto
  <info>string</info>  <strong>$in_locale</strong>  El formato regional opcional a usar para mostrar el nombre del lenguaje

<comment>Return:</comment>
  <info>string</info>  El nombre manifiesto del lenguaje de la configuración regional dada por $locale en el
          formato apropiado dado por $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayName
type: function
doc:
<comment>Description:</comment>
  Devolver un nombre manifiesto debidamente localizado de la configuración regional de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nombre manifiesto debidamente localizado de la configuración regional de entrada. Si
  es <info>null</info> se utiliza la configuración regional predeterminada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>     La configuración regional de la que devolver un nombre manifiesto.
  <info>string</info>  <strong>$in_locale</strong>  Formato regional opcional

<comment>Return:</comment>
  <info>string</info>  El nombre manifiesto de la configuración regional con el formato apropiado dado por
          $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayRegion
type: function
doc:
<comment>Description:</comment>
  Devolver un nombre manifiesto debidamente localizado de la región de la configuración regional de
  entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nombre manifiesto debidamente localizado de la región de la configuración regional de
  entrada. Si es <info>null</info> se utiliza la configuración regional predeterminada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>     La configuración regional de la que devolver una región manifiesta.
  <info>string</info>  <strong>$in_locale</strong>  El formato regional opcional a usar para mostrar el nombre de la región

<comment>Return:</comment>
  <info>string</info>  El nombre manifiesto de la región de la configuración regional dada por $locale en el
          formato apropiado dado por $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayScript
type: function
doc:
<comment>Description:</comment>
  Devolver un nombre manifiesto debidamente localizado de la escritura de la configuración regional
  de
  entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nombre manifiesto debidamente localizado de la escritura de la configuración regional
  de entrada. Si es <info>null</info> se utiliza la configuración regional predeterminada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>     La configuración regional de la que devolver una escritura manifiesta.
  <info>string</info>  <strong>$in_locale</strong>  El formato regional opcional a usar para mostrar el nombre de la escritura

<comment>Return:</comment>
  <info>string</info>  El nombre manifiesto de la escritura de la configuración regional dada por $locale en el
          formato apropiado dado por $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayVariant
type: function
doc:
<comment>Description:</comment>
  Devolver un nombre manifiesto debidamente localizado de las variantes de la configuración regional
  de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nombre manifiesto debidamente localizado de las variantes de la configuración regional
  de entrada. Si es <info>null</info> se utiliza la configuración regional predeterminada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>     La configuración regional de la que devolver una variante manifiesta.
  <info>string</info>  <strong>$in_locale</strong>  El formato regional opcional a usar para mostrar el nombre de la variante

<comment>Return:</comment>
  <info>string</info>  El nombre manifiesto de la variante de la configuración regional dada por $locale en el
          formato apropiado dado por $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>


id: Locale::getKeywords
type: function
doc:
<comment>Description:</comment>
  Obtener las palabras clave de la configuración regional de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene las palabras clave de la configuración regional de entrada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional de la que extraer las palabras clave.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> asociativo que contiene los pares palabras-clave/valor de esta configuración
         regional

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


id: Locale::getPrimaryLanguage
type: function
doc:
<comment>Description:</comment>
  Obtener el lenguaje principal de la configuración regional de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el lenguaje principal de la configuración regional de entrada

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional desde la que extraer el código del lenguaje principal

<comment>Return:</comment>
  <info>string</info>  El código de lenguaje asociado con el lenguaje o <info>null</info> en caso de error.

<comment>See Also:</comment>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_region()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::getRegion
type: function
doc:
<comment>Description:</comment>
  Obtener la región de la configuración local de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene la región de la configuración local de entrada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional desde la que extraer el código de región

<comment>Return:</comment>
  <info>string</info>  La subetiqueta de región de la configuración regional o <info>null</info> si no está presente

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::getScript
type: function
doc:
<comment>Description:</comment>
  Obtener la escritura de la configuración regional de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene la escritura de la configuración regional de entrada.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional desde la que extraer el código de la escritura

<comment>Return:</comment>
  <info>string</info>  La subetiqueta de la escritura de la configuración regional o <info>null</info> si no está presente

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_region()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::lookup
type: function
doc:
<comment>Description:</comment>
  Busca en la lista de etiquetas de lenguaje la mejor coincidencia para el lenguaje
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Busca los elementos en <strong>$langtag</strong> para la mejor coincidencia con el rango de lenguajes especificado
  en <strong>$locale</strong> de acuerdo al algorítmo de búsqueda de RFC 4647.

<comment>Param:</comment>
  <info>array</info>   <strong>$langtag</strong>       Un <info>array</info> que contiene una lista de etiquetas de lenguaje para compararlas
                         con <strong>$locale</strong>. Se permiten 100 elementos máximo.
  <info>string</info>  <strong>$locale</strong>        La configuración regional a usar como rango de lenguajes en la comparación.
  <info>bool</info>    <strong>$canonicalize</strong>  Si es verdadero (true), los argumentos serán convertidos a su forma
                         canónica antes de la comparación.
  <info>string</info>  <strong>$default</strong>       La configuración regional a usar si no se encuentra ninguna coincidencia.

<comment>Return:</comment>
  <info>string</info>  La etiqueta de lenguaje más parecida o el valor del parámetro default.

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


id: Locale::parseLocale
type: function
doc:
<comment>Description:</comment>
  Devolver un array de claves-valores de los elementos de las subetiquetas del ID regional
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un array de claves-valores de los elementos de las subetiquetas del ID regional.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional de donde extraer el array de subetiquetas. Nota: Las
                   subetiquetas 'variant' y 'private' pueden tomar un máximo de 15 valores mientras
                   que 'extlang' puede tomar un máximo de 3 valores.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene una lista pares clave-valor, donde las claves identifican
         las subetiquetas del ID regional en particular, y los valores son los valores de las
         subetiquetas asociadas. El array será ordenado de la misma forma que las subetiquetas del
         ID regional, p.ej. si las variantes del ID regional son '-varX-varY-varZ', el array
         devuelto contendrá variant0=&gt;varX , variant1=&gt;varY , variant2=&gt;varZ

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


id: Locale::setDefault
type: function
doc:
<comment>Description:</comment>
  Establecer la configuración regional predeterminada en tiempo de ejecución
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece la configuración regional predeterminada en tiempo de ejecución a $locale. Esto cambia
  el valor del identificador regional global 'default_locale' de INTL. Se aceptan extensiones UAX
  #35.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  Es una etiqueta de lenguaje que satisface el estándar BCP 47.

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


id: Lua::__call
type: function
doc:
<comment>Description:</comment>
  Llama funciones de Lua
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>callable</info>  <strong>$lua_func</strong>  Nombre de la función en Lua
  <info>array</info>     <strong>$args</strong>      Argumentos pasados a la función de Lua
  <info>int</info>       <strong>$use_self</strong>  Cuando se debe usar <return>self</return>

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el resultado de la función llamada, <info>null</info> si los argumentos son inválidos o <info>false</info>
         en caso de error.

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


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

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


id: Lua::assign
type: function
doc:
<comment>Description:</comment>
  Asigna una variable de PHP a Lua
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>mixed</info>  Devuelve $this o <info>null</info> en caso de error.


id: Lua::eval
type: function
doc:
<comment>Description:</comment>
  Evalúa una cadena de texto como código Lua
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el resultado del código evaluado, <info>null</info> si los parámetros son inválidos o <info>false</info> en
         caseo de error.


id: Lua::getVersion
type: function
doc:
<comment>Description:</comment>
  Obtiene la versión
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>string</info>  Devuelve Lua::LUA_VERSION.


id: Lua::include
type: function
doc:
<comment>Description:</comment>
  Analiza un fichero script Lua
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el resultado del código incluido, <info>null</info> en caso que los argumentos pasados sean
         erróneos o <info>false</info> para cualquier otro tipo de error.


id: Lua::registerCallback
type: function
doc:
<comment>Description:</comment>
  Registra una función PHP en Lua
  
  Registra una función PHP en Lua con el nombre de función que se indique en "$name"

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      
  <info>callable</info>  <strong>$function</strong>  Una función de llamada de retorno válida PHP

<comment>Return:</comment>
  <info>mixed</info>  Devuelve $this, <info>null</info> en caso que los argumentos sean erróneos o <info>false</info> para cualquier otro
         tipo de error.


id: LuaClosure
type: class
doc:
<comment>Description:</comment>
  LuaClosure es una clase contenedor para LUA_TFUNCTION que puede ser devuelta al llamar a la
  función Lua.


id: LuaClosure::__invoke
type: function
doc:
<comment>Description:</comment>
  Invoke luaclosure
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  

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


id: LuaSandbox
type: class
doc:
<comment>Description:</comment>
  The LuaSandbox class creates a Lua environment and allows for execution of Lua code.


id: LuaSandbox::PERCENT
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in percentages of the total.


id: LuaSandbox::SAMPLES
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in samples.


id: LuaSandbox::SECONDS
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in seconds.


id: LuaSandbox::callFunction
type: function
doc:
<comment>Description:</comment>
  Call a function in a Lua global variable
  
  Calls a function in a Lua global variable.
  
  If the name contains "." characters, the function is located via recursive table accesses, as if
  the name were a Lua expression.
  
  If the variable does not exist, or is not a function, false will be returned and a warning issued.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Lua variable name.
  <info>mixed</info>   <strong>$args</strong>  Arguments to the function.

<comment>Return:</comment>
  <info>array|bool</info>  Returns an <info>array</info> of values returned by the Lua function, which may be empty,  o <info>false</info>
              en caso de error.


id: LuaSandbox::disableProfiler
type: function
doc:
<comment>Description:</comment>
  Disable the profiler
  
  Disables the profiler.

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

<comment>See Also:</comment>
   * LuaSandbox::enableProfiler
   * LuaSandbox::getProfilerFunctionReport


id: LuaSandbox::enableProfiler
type: function
doc:
<comment>Description:</comment>
  Enable the profiler.
  
  Enables the profiler. Profiling will begin when Lua code is entered.
  
  The profiler periodically samples the Lua environment to record the running function. Testing
  indicates that at least on Linux, setting a period less than 1ms will lead to a high overrun count
  but no performance problems.

<comment>Param:</comment>
  <info>float</info>  <strong>$period</strong>  Sampling period in seconds.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean indicating whether the profiler is enabled.

<comment>See Also:</comment>
   * LuaSandbox::disableProfiler
   * LuaSandbox::getProfilerFunctionReport


id: LuaSandbox::getCPUUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the current CPU time usage of the Lua environment
  
  Fetches the current CPU time usage of the Lua environment.
  
  This includes time spent in PHP callbacks.

<comment>Return:</comment>
  <info>float</info>  Returns the current CPU time usage in seconds.
         
         On Windows, this function always returns zero. On operating systems that do not support
         <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, this function will return the
         elapsed wall-clock time, not CPU time.

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::setCPULimit


id: LuaSandbox::getMemoryUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the current memory usage of the Lua environment
  
  Fetches the current memory usage of the Lua environment.

<comment>Return:</comment>
  <info>int</info>  Returns the current memory usage in bytes.

<comment>See Also:</comment>
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::getPeakMemoryUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the peak memory usage of the Lua environment
  
  Fetches the peak memory usage of the Lua environment.

<comment>Return:</comment>
  <info>int</info>  Returns the peak memory usage in bytes.

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::getProfilerFunctionReport
type: function
doc:
<comment>Description:</comment>
  Fetch profiler data
  
  For a profiling instance previously started by LuaSandbox::enableProfiler, get a report of the
  cost of each function.
  
  The measurement unit used for the cost is determined by the $units parameter:
  
  <info>LuaSandbox::SAMPLES</info>Measure in number of samples.<info>LuaSandbox::SECONDS</info>Measure in seconds of CPU
  time.<info>LuaSandbox::PERCENT</info>Measure percentage of CPU time.
  
  Measure in number of samples.
  
  Measure in seconds of CPU time.
  
  Measure percentage of CPU time.

<comment>Param:</comment>
  <info>int</info>  <strong>$units</strong>  Measurement unit constant.

<comment>Return:</comment>
  <info>array</info>  Returns profiler measurements, sorted in descending order, as an associative <info>array</info>. Keys
         are the Lua function names (with source file and line defined in angle brackets), values
         are the measurements as <info>int</info> or <info>float</info>.
         
         On Windows, this function always returns an empty array. On operating systems that do not
         support <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, this function will report
         the elapsed wall-clock time, not CPU time.


id: LuaSandbox::getVersionInfo
type: function
doc:
<comment>Description:</comment>
  Return the versions of LuaSandbox and Lua
  
  Returns the versions of LuaSandbox and Lua.

<comment>Return:</comment>
  <info>array</info>  Returns an array with two keys:
         
         elementtypedescriptionLuaSandbox<info>string</info>The version of the LuaSandbox extension.Lua<info>string</info>The
         library name and version as defined by the LUA_RELEASE macro, for example, "Lua 5.1.5".


id: LuaSandbox::loadBinary
type: function
doc:
<comment>Description:</comment>
  Load a precompiled binary chunk into the Lua environment
  
  Loads data generated by LuaSandboxFunction::dump.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>       Data from LuaSandboxFunction::dump.
  <info>string</info>  <strong>$chunkName</strong>  Name for the loaded function.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class>.

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


id: LuaSandbox::loadString
type: function
doc:
<comment>Description:</comment>
  Load Lua code into the Lua environment
  
  Loads Lua code into the Lua environment.
  
  This is the equivalent of standard Lua's <return>loadstring()</return> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>       Lua code.
  <info>string</info>  <strong>$chunkName</strong>  Name for the loaded chunk, for use in error traces.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class> which, when executed, will execute the passed
                      $code.

<comment>See Also:</comment>
   * LuaSandbox::registerLibrary
   * LuaSandbox::wrapPhpFunction


id: LuaSandbox::pauseUsageTimer
type: function
doc:
<comment>Description:</comment>
  Pause the CPU usage timer
  
  Pauses the CPU usage timer.
  
  This only has effect when called from within a callback from Lua. When execution returns to Lua,
  the timer will be automatically unpaused. If a new call into Lua is made, the timer will be
  unpaused for the duration of that call.
  
  If a PHP callback calls into Lua again with timer not paused, and then that Lua function calls
  into PHP again, the second PHP call will not be able to pause the timer. The logic is that even
  though the second PHP call would avoid counting the CPU usage against the limit, the first call
  still counts it.

<comment>Return:</comment>
  <info>bool</info>  Returns a <info>bool</info> indicating whether the timer is now paused.

<comment>See Also:</comment>
   * LuaSandbox::setCPULimit
   * LuaSandbox::unpauseUsageTimer


id: LuaSandbox::registerLibrary
type: function
doc:
<comment>Description:</comment>
  Register a set of PHP functions as a Lua library
  
  Registers a set of PHP functions as a Lua library, so that Lua can call the relevant PHP code.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>string</info>  <strong>$libname</strong>    The name of the library. In the Lua state, the global variable of this name
                      will be set to the table of functions. If the table already exists, the new
                      functions will be added to it.
  <info>array</info>   <strong>$functions</strong>  An <info>array</info>, where each key is a function name, and each value is a corresponding
                      PHP <info>callable</info>.

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

<comment>See Also:</comment>
   * LuaSandbox::loadString
   * LuaSandbox::wrapPhpFunction


id: LuaSandbox::setCPULimit
type: function
doc:
<comment>Description:</comment>
  Set the CPU time limit for the Lua environment
  
  Sets the CPU time limit for the Lua environment.
  
  If the total user and system time used by the environment after the call to this method exceeds
  this limit, a <class>LuaSandboxTimeoutError</class> exception is thrown.
  
  Time used in PHP callbacks is included in the limit.
  
  Setting the time limit from a callback while Lua is running causes the timer to be reset, or
  started if it was not already running.
  
  On Windows, the CPU limit will be ignored. On operating systems that do not support
  <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, wall-clock time rather than CPU time will
  be limited.

<comment>Param:</comment>
  <info>float|bool</info>  <strong>$limit</strong>  Limit as a <info>float</info> in seconds, or <info>false</info> for no limit.

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

<comment>See Also:</comment>
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::setMemoryLimit
type: function
doc:
<comment>Description:</comment>
  Set the memory limit for the Lua environment
  
  Sets the memory limit for the Lua environment.
  
  If this limit is exceeded, a <class>LuaSandboxMemoryError</class> exception is thrown.

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  Memory limit in bytes.

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

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::setCPULimit


id: LuaSandbox::unpauseUsageTimer
type: function
doc:
<comment>Description:</comment>
  Unpause the timer paused by LuaSandbox::pauseUsageTimer
  
  Unpauses the timer paused by LuaSandbox::pauseUsageTimer.

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

<comment>See Also:</comment>
   * LuaSandbox::pauseUsageTimer
   * LuaSandbox::setCPULimit


id: LuaSandbox::wrapPhpFunction
type: function
doc:
<comment>Description:</comment>
  Wrap a PHP callable in a LuaSandboxFunction
  
  Wraps a PHP callable in a <class>LuaSandboxFunction</class>, so it can be passed into Lua as an anonymous
  function.
  
  The function must return either an array of values (which may be empty), or <info>null</info> which is
  equivalent to returning the empty array.
  
  Exceptions will be raised as errors in Lua, however only <class>LuaSandboxRuntimeError</class> exceptions may be
  caught inside Lua with <return>pcall()</return> or <return>xpcall()</return>.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  Callable to wrap.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class>.

<comment>See Also:</comment>
   * LuaSandbox::loadString
   * LuaSandbox::registerLibrary


id: LuaSandboxErrorError
type: class
doc:
<comment>Description:</comment>
  Exception thrown when Lua encounters an error inside an error handler.


id: LuaSandboxFatalError
type: class
doc:
<comment>Description:</comment>
  Uncatchable LuaSandbox exceptions.
  
  These may not be caught inside Lua using <return>pcall()</return> or <return>xpcall()</return>.


id: LuaSandboxFunction
type: class
doc:
<comment>Description:</comment>
  Represents a Lua function, allowing it to be called from PHP.
  
  A LuaSandboxFunction may be obtained as a return value from Lua, as a parameter passed to a
  callback from Lua, or by using LuaSandbox::wrapPhpFunction, LuaSandbox::loadString, or
  LuaSandbox::loadBinary.


id: LuaSandboxFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Unused
  
  <class>LuaSandboxFunction</class> are obtained as a return value from Lua, as a parameter passed to a callback
  from Lua, or by using LuaSandbox::wrapPhpFunction, LuaSandbox::loadString, or
  LuaSandbox::loadBinary. They cannot be constructed directly.


id: LuaSandboxFunction::call
type: function
doc:
<comment>Description:</comment>
  Call a Lua function
  
  Calls a Lua function.
  
  Errors considered to be the fault of the PHP code will result in the function returning <info>false</info> and
  <info>E_WARNING</info> being raised, for example, a <info>resource</info> type being used as an argument. Lua errors will
  result in a <class>LuaSandboxRuntimeError</class> exception being thrown.
  
  PHP and Lua types are converted as follows:
  
  PHP <info>null</info> is Lua <return>nil</return>, and vice versa. PHP <info>int</info>s and <info>float</info>s are converted to Lua numbers. Infinity
  and <info>NAN</info> are supported.  Lua numbers without a fractional part between approximately <return>-2**53</return> and
  <return>2**53</return> are converted to PHP <info>int</info>s, with others being converted to PHP <info>float</info>s. PHP <info>bool</info>s are Lua
  booleans, and vice versa.PHP <info>string</info>s are Lua strings, and vice versa. Lua functions are PHP
  <class>LuaSandboxFunction</class> objects, and vice versa. General PHP <info>callable</info>s are not supported.  PHP <info>array</info>s
  are converted to Lua tables, and vice versa.  Note that Lua typically indexes arrays from 1, while
  PHP indexes arrays from 0. No adjustment is made for these differing conventions. Self-referential
  arrays are not supported in either direction.PHP references are dereferenced. Lua <return>__pairs</return> and
  <return>__ipairs</return> are processed. <return>__index</return> is ignored.  When converting from PHP to Lua, integer keys between
  <return>-2**53</return> and <return>2**53</return> are represented as Lua numbers. All other keys are represented as Lua strings.
  When converting from Lua to PHP, keys other than strings and numbers will result in an error, as
  will collisions when converting numbers to strings or vice versa (since PHP considers things like
  <return>$a[0]</return> and <return>$a["0"]</return> as being equivalent).  All other types are unsupported and will raise an
  error/exception, including general PHP <info>object</info>s and Lua userdata and thread types.
  
  PHP <info>null</info> is Lua <return>nil</return>, and vice versa.
  
  PHP <info>int</info>s and <info>float</info>s are converted to Lua numbers. Infinity and <info>NAN</info> are supported.
  
  Lua numbers without a fractional part between approximately <return>-2**53</return> and <return>2**53</return> are converted to PHP
  <info>int</info>s, with others being converted to PHP <info>float</info>s.
  
  PHP <info>bool</info>s are Lua booleans, and vice versa.
  
  PHP <info>string</info>s are Lua strings, and vice versa.
  
  Lua functions are PHP <class>LuaSandboxFunction</class> objects, and vice versa. General PHP <info>callable</info>s are not
  supported.
  
  PHP <info>array</info>s are converted to Lua tables, and vice versa.
  
   Note that Lua typically indexes arrays from 1, while PHP indexes arrays from 0. No adjustment is
  made for these differing conventions. Self-referential arrays are not supported in either
  direction.PHP references are dereferenced. Lua <return>__pairs</return> and <return>__ipairs</return> are processed. <return>__index</return> is
  ignored.  When converting from PHP to Lua, integer keys between <return>-2**53</return> and <return>2**53</return> are represented
  as Lua numbers. All other keys are represented as Lua strings.  When converting from Lua to PHP,
  keys other than strings and numbers will result in an error, as will collisions when converting
  numbers to strings or vice versa (since PHP considers things like <return>$a[0]</return> and <return>$a["0"]</return> as being
  equivalent).
  
  Note that Lua typically indexes arrays from 1, while PHP indexes arrays from 0. No adjustment is
  made for these differing conventions.
  
  Self-referential arrays are not supported in either direction.
  
  PHP references are dereferenced.
  
  Lua <return>__pairs</return> and <return>__ipairs</return> are processed. <return>__index</return> is ignored.
  
  When converting from PHP to Lua, integer keys between <return>-2**53</return> and <return>2**53</return> are represented as Lua
  numbers. All other keys are represented as Lua strings.
  
  When converting from Lua to PHP, keys other than strings and numbers will result in an error, as
  will collisions when converting numbers to strings or vice versa (since PHP considers things like
  <return>$a[0]</return> and <return>$a["0"]</return> as being equivalent).
  
  All other types are unsupported and will raise an error/exception, including general PHP <info>object</info>s
  and Lua userdata and thread types.
  
  Lua functions inherently return a list of results. So on success, this method returns an <info>array</info>
  containing all of the values returned by Lua, with <info>int</info> keys starting from zero. Lua may return no
  results, in which case an empty array is returned.

<comment>Param:</comment>
  <info>string</info>  <strong>$args</strong>  Arguments passed to the function.

<comment>Return:</comment>
  <info>array|bool</info>  Returns an <info>array</info> of values returned by the function, which may be empty, o <info>false</info> en
              caso de error.


id: LuaSandboxFunction::dump
type: function
doc:
<comment>Description:</comment>
  Dump the function as a binary blob
  
  Dumps the function as a binary blob.

<comment>Return:</comment>
  <info>string</info>  Returns a string that may be passed to LuaSandbox::loadBinary.


id: LuaSandboxRuntimeError
type: class
doc:
<comment>Description:</comment>
  Catchable LuaSandbox runtime exceptions.
  
  These may be caught inside Lua using <return>pcall()</return> or <return>xpcall()</return>.


id: MB_CASE_FOLD
type: constant
doc:
<comment>Description:</comment>
  Realiza una conversión de doblaje de mayúsculas y minúsculas que elimina las distinciones de
  mayúsculas y minúsculas presentes en el string. Esto se utiliza para la comparación de los casos.
  Esto puede cambiar la longitud del string. Disponible desde PHP 7.3.


id: MB_CASE_FOLD_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Realiza una simple conversión de doblaje de mayúsculas y minúsculas que elimina las distinciones
  de mayúsculas y minúsculas presentes en el string. Esto se utiliza para la comparación de los
  casos. Esto no cambia la longitud del string. Utilizado por las operaciones insensibles a los
  casos internamente por la extensión MBString. Disponible a partir de PHP 7.3.


id: MB_CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  Realiza un doblaje completo de las minúsculas. Esto puede cambiar la longitud del string. Este es
  el modo utilizado por mb_strtolower().


id: MB_CASE_LOWER_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Realiza una simple conversión de doblaje en minúsculas. Esto no cambia la longitud del string.
  Disponible a partir de PHP 7.3.


id: MB_CASE_TITLE
type: constant
doc:
<comment>Description:</comment>
  Realiza una conversión completa título-caso basada en las propiedades derivadas de Unicode Cased y
  CaseIgnorable. En particular, esto mejora el manejo de las comillas y los apóstrofes. Esto puede
  cambiar la longitud del string.


id: MB_CASE_TITLE_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Realiza una simple conversión de doblado de título-caso. Esto no cambia la longitud del string.
  Disponible a partir de PHP 7.3.


id: MB_CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  Realiza un doblaje completo de las mayúsculas. Esto puede cambiar la longitud del string. Este es
  el modo utilizado por mb_strtoupper().


id: MB_CASE_UPPER_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Realiza una simple conversión de doblado de mayúsculas. Esto no cambia la longitud del string.
  Disponible a partir de PHP 7.3.


id: MB_ONIGURUMA_VERSION
type: constant
doc:
<comment>Description:</comment>
  La versión de Oniguruma, p.e. <return>6.9.4</return>. Disponible a partir de PHP 7.4.


id: MK_E_UNAVAILABLE
type: constant
doc:
<comment>Description:</comment>
  -2147221021
  
  Código de estado COM de iMoniker, devuelto en errores donde la llamada a la función falló a causa
  de no estar disponible.


id: MT_RAND_MT19937
type: constant
doc:
<comment>Description:</comment>
  Indicates that the correct Mt19937 (Mersenne Twister) implementation will be used by the
  algorithm, when creating a <class>Random\Engine\Mt19937</class> instance using
  <strong>Random\Engine\Mt19937::__construct()</strong> or seeding the global Mersenne Twister with <strong>mt_srand()</strong>.


id: MT_RAND_PHP
type: constant
doc:
<comment>Description:</comment>
  Indicates that an incorrect Mersenne Twister implementation will be used by the algorithm, when
  creating a <class>Random\Engine\Mt19937</class> instance using <strong>Random\Engine\Mt19937::__construct()</strong> or seeding
  the global Mersenne Twister with <strong>mt_srand()</strong>.
  
  The incorrect implementation is available for backwards compatibility with <strong>mt_srand()</strong> prior to PHP
  7.1.0.
  
  This feature has been
  DEPRECATED as of PHP 8.3.0. Relying on this feature
  is highly discouraged.


id: MYSQL_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Las columnas son devueltas en un array que tiene los nombres de los campos como los índices del
  array.


id: MYSQL_ATTR_COMPRESS
type: constant
doc:
<comment>Description:</comment>
  Activa la compresión de comunicación de red. Esta también se admite cuando se realizó la
  compilación con mysqlnd, a partir de PHP 5.3.11.


id: MYSQL_ATTR_FOUND_ROWS
type: constant
doc:
<comment>Description:</comment>
  Devuelve el número de filas encontradas (coindicentes), no el número de filas modificadas.


id: MYSQL_ATTR_IGNORE_SPACE
type: constant
doc:
<comment>Description:</comment>
  Permite espacios después de los nombres de función. Hace de todos los nombres  de función palabras
  reservadas.


id: MYSQL_ATTR_INIT_COMMAND
type: constant
doc:
<comment>Description:</comment>
  Comando a ejecutar cuando se conecta al servidor MySQL. Al reconectar se volverá a ejecutar
  automáticamente.
  
  Se ha de tener en cuenta que esta constante se puede usar solamente en el array <strong>$driver_options</strong>
  cuando se construye un nuevo gestor de base de datos.


id: MYSQL_ATTR_LOCAL_INFILE
type: constant
doc:
<comment>Description:</comment>
  Activa <return>LOAD LOCAL INFILE</return>.
  
  Se ha de tener en cuenta que esta constante se puede usar solamente en el array <strong>$driver_options</strong>
  cuando se construye un nuevo gestor de base de datos.


id: MYSQL_ATTR_MAX_BUFFER_SIZE
type: constant
doc:
<comment>Description:</comment>
  Tamaño máximo del búfer. Lo predeterminado es MiB. Esta constante no está admitida cuando se
  compila para mysqlnd.


id: MYSQL_ATTR_READ_DEFAULT_FILE
type: constant
doc:
<comment>Description:</comment>
  Lee las opciones desde el fichero indicado en lugar de my.cnf. Si se usa mysqlnd, esta opción no
  está disponible debido a que mysqlnd no lee los fichero de configuración de mysql.


id: MYSQL_ATTR_READ_DEFAULT_GROUP
type: constant
doc:
<comment>Description:</comment>
  Opciones de lectura del grupo indicado desde my.cnf o desde el fichero especificado con
  <info>MYSQL_READ_DEFAULT_FILE</info>.  Si se usa mysqlnd, esta opción no está disponible debido a que mysqlnd
  no lee los ficheros de configuración de mysql.


id: MYSQL_ATTR_SSL_CA
type: constant
doc:
<comment>Description:</comment>
  La ruta al fichero de la autoridad certificadora SSL.
  
  Existe a partir de PHP  5.3.7.


id: MYSQL_ATTR_SSL_CAPATH
type: constant
doc:
<comment>Description:</comment>
  La ruta al directorio que contiene los certificados AC SSL autorizados, los cuales están
  almacenados en formato PEM.
  
  Existe a partir de PHP  5.3.7.


id: MYSQL_ATTR_SSL_CERT
type: constant
doc:
<comment>Description:</comment>
  La ruta al fichero del certificado SSL.
  
  Existe a partir de PHP  5.3.7.


id: MYSQL_ATTR_USE_BUFFERED_QUERY
type: constant
doc:
<comment>Description:</comment>
  Si este atributo es definido como <info>true</info> en <class>PDOStatement</class>, el controlador de MySQL usará las
  versiones de la API de MySQL guardadas en el búfer. Si se está escribiendo código portable, en su
  lugar se debería usar <strong>PDOStatement::fetchAll()</strong>.
  
  Forzar consultas para que sean guardadas en el búfer en mysqlgetAttribute(PDO::ATTR_DRIVER_NAME)
  == 'mysql') { $sentencia = $bs->prepare('select * from foo',
  array(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
  } else { die("mi aplicación sólo funciona con mysql; debería usar \$sentencia->fetchAll() en su
  lugar");
  }
  ?>
  ]]>


id: MYSQL_BOTH
type: constant
doc:
<comment>Description:</comment>
  Las columnas son devueltas en un array que tiene tanto índice numérico como un índice con los
  nombres de los campos.


id: MYSQL_CLIENT_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  Permitir unos segundos interactive_timeout seconds (en vez de wait_timeout) de inactividad antes
  del cierre de la conexión.


id: MYSQL_CLIENT_SSL
type: constant
doc:
<comment>Description:</comment>
  Usar encriptación SSL. Este flag solo esta disponible con la versión de la libreria de cliente de
  MySQL 4.x o superior. La versión 3.23.x se incluye tanto con PHP 4 como con los binarios para
  Windows de PHP 5.


id: MYSQL_NUM
type: constant
doc:
<comment>Description:</comment>
  Las columnas son devueltas en un array que tiene un índice numérico para los campos. Este índice
  empieza con 0, con el primer campo en el resultado.


id: Memcache::add
type: function
doc:
<comment>Description:</comment>
  Añadir un valor en el servidor
  
  <strong>Memcache::add()</strong> guarda la variable <strong>$var</strong> con la clave <strong>$key</strong> solamente si la clave no existe todavía
  en el servidor. También se puede usar la función <strong>memcache_add()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     La clave que quedará asociada con el valor.
  <info>mixed</info>   <strong>$var</strong>     La variable a guardar. Cadenas y enteros se guardan tal y como son,  otros tipos
                   se guardan serializados.
  <info>int</info>     <strong>$flag</strong>    Use <info>MEMCACHE_COMPRESSED</info> para guardar datos comprimidos (usa zlib).
  <info>int</info>     <strong>$expire</strong>  Tiempo de expiración del valor. Si es iqual a cero, el valor nunca expirará.
                   También puedes usar Unix timestamp o el número de segundos empezando desde la
                   fecha actual, el valor no puede exceder de  2592000 segundos (30 días).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Devuelve <info>false</info> si la clave ya
        existe. Por el resto <strong>Memcache::add()</strong> se comporta similar a  <strong>Memcache::set()</strong>.

<comment>See Also:</comment>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::addServer
type: function
doc:
<comment>Description:</comment>
  Añadir servidor memcache al grupo de conexiones
  
  <strong>Memcache::addServer()</strong> añade un servidor al grupo de conexiones. También se puede usar la función
  <strong>memcache_add_server()</strong>.
  
  Cuando se usa este método (opuestamente a <strong>Memcache::connect()</strong> y <strong>Memcache::pconnect()</strong>) la conexión
  no se establece hasta que es necesaria. De esta forma no hay sobrecarga al añadir un gran número
  de servidores en el grupo de conexiones, aunque no todos van a ser utilizados.
  
  La conexión puede caer en cualquier momento usando cualquiera de los métodos, mientras otros
  servidores estén disponibles para hacer la petición el usuario no notará nada. Cualquier tipo de
  errores de socket o servidor Memcached (excepto out-of-memory) seguramente harán caer la conexión.
  Errores en el cliente como añadir una llave que ya existe no provocará la caida de la conexión.
  
  Esta función fué añadida en Memcache versión 2.0.0.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>              Apunta al host donde memcached está esperando conexiones. Este
                               parámetro también se puede especificar con otros transportes como
                               <return>unix:///path/to/memcached.sock</return> para usar domain UNIX sockets,  en
                               este caso <strong>$port</strong> debe también establecerse a <return>0</return>.
  <info>int</info>       <strong>$port</strong>              Apunta al puerto donde memcache está esperando para conexiones.
                               Establece este parámetro a <return>0</return> cuando se usan UNIX domain sockets.
                               
                               Por favor note: <strong>$port</strong> será por defecto memcache.default_port en caso
                               de no especificarse. Por esta razón, se recomienda especificar el
                               puerto explícitamente en la llamada a este método.
  <info>bool</info>      <strong>$persistent</strong>        Controla el uso de una conexión persistente. Por defecto <info>true</info>.
  <info>int</info>       <strong>$weight</strong>            Número de segmentos para crear de este servidor, que a su vez
                               controlan la probabilidad de que sea seleccionado. La probabilidad es
                               relativa a la de peso total de todos los servidores.
  <info>int</info>       <strong>$timeout</strong>           Valor en segundos que se utilizará para conectar con el demonio.
                               Piense dos veces antes de cambiar el valor predeterminado de 1
                               segundo - se  puede perder todas las ventajas de la caché si su
                               conexión es demasiado lenta.
  <info>int</info>       <strong>$retry_interval</strong>    Controla la frecuencia de reintentos cuando falla la conexión, el
                               valor por defecto es  15 segundos. Si establece este parámetro a -1
                               desactivará el reintento automático. Ni esta opción ni el parámetro
                               <strong>$persistent</strong> tienen ningún efecto cuando la extensión se carga
                               dinámicamente a través de <strong>dl()</strong>.
                               
                               Cada conexión struct fallida tiene su propio timeout y antes de que
                               caduque, el struct será omitido cuando se selecionen backends para
                               servir una petición.Cuando caduque la conexión se reconectará
                               satisfactoriamente o se marcará como fallida por otros
                               <strong>$retry_interval</strong> segundos. El típico efecto es que cada servidor web
                               hijo reintentará la conexión cada <strong>$retry_interval</strong>  cuando se sirven
                               páginas.
  <info>bool</info>      <strong>$status</strong>            Controla si el servidor debe ser marcado como online. Estableciendo
                               este parámetro a <info>false</info> y <strong>$retry_interval</strong> a -1 permite a un servidor
                               que falle a ser mantenido en el grupo para no afectar el algoritmo de
                               distribución de llaves. Las peticiones a este servidor fallarán
                               inmediatamente dependiendo en la opción <strong>$memcache.allow_failover</strong>. Por
                               defecto to <info>true</info>, que significa que el servidor se considera online.
  <info>callable</info>  <strong>$failure_callback</strong>  Permite al usuario a especificar la llamada a una función de retorno
                               a ejectuar cuando se encuentre un error. La llamada de retorno se
                               ejecuta antes de que se produzca la  caída en la conexión. La función
                               toma dos parámetros, el hostname y el puerto del puerto que ha
                               fallado.
  <info>int</info>       <strong>$timeoutms</strong>         

<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>
   * <strong>Memcache::connect()</strong>
   * <strong>Memcache::pconnect()</strong>
   * <strong>Memcache::close()</strong>
   * <strong>Memcache::setServerParams()</strong>
   * <strong>Memcache::getServerStatus()</strong>


id: Memcache::close
type: function
doc:
<comment>Description:</comment>
  Cierra la conexión al servidor memcached
  
  <strong>Memcache::close()</strong> cierra la conexión al servidor memcached. Esta función no cierra conexiones
  persistentes, que solo son cerradas durante apagado/reinicio del servidor web. También se puede
  usar la función <strong>memcache_close()</strong>.

<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>
   * <strong>Memcache::connect()</strong>
   * <strong>Memcache::pconnect()</strong>


id: Memcache::connect
type: function
doc:
<comment>Description:</comment>
  Abre una conexión al servidor memcached
  
  <strong>Memcache::connect()</strong> establece una conexión al servidor memcached. La conexión, que fue abierta
  usando <strong>Memcache::connect()</strong> será  automáticamente cerrada al finalizar la ejecucción del script.
  También se puede cerrar con <strong>Memcache::close()</strong>. También puede usar la función <strong>memcache_connect()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     El host donde el memcached está esperando conexiones. En este parámetro también
                    se puede especificar otros transporte como  <return>unix:///path/to/memcached.sock</return> para
                    usar UNIX domain sockets. En este caso <strong>$port</strong> debe ser establecido a <return>0</return>.
  <info>int</info>     <strong>$port</strong>     El puerto donde memcached está esperando conexiones. Establezca este parámetro a
                    <return>0</return> cuando se usan UNIX domain sockets.
                    
                    Por favor note: <strong>$port</strong> será por defecto memcache.default_port en caso de no
                    especificarse. Por esta razón, se recomienda especificar el puerto
                    explícitamente en la llamada a este método.
  <info>int</info>     <strong>$timeout</strong>  Valor en segundos que se utilizarán para conectarse al demonio. Piensa dos veces
                    antes de cambiar el valor por defecto de 1 segundo, puedes perder todas la
                    ventajas del caché si tus conexiones son muy lentas.

<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>
   * <strong>Memcache::pconnect()</strong>
   * <strong>Memcache::close()</strong>


id: Memcache::decrement
type: function
doc:
<comment>Description:</comment>
  Decrementa numéricamente un valor
  
  <strong>Memcache::decrement()</strong> decrementa numéricamente el valor según el <strong>$value</strong>. Es similar a
  <strong>Memcache::increment()</strong>, después de que el <strong>$value</strong> sea extraído el valor es convertido a numérico.
  El nuevo valor del objecto no será inferior a cero.   No use <strong>Memcache::decrement()</strong> en un valor,
  que fué guardado con compresión, porque en este caso <strong>Memcache::get()</strong> no funcionará.
  <strong>Memcache::decrement()</strong> no genera un valor si no existía previamente. También se puede usar la
  función <strong>memcache_decrement()</strong>.
  
  El nuevo valor del objecto no será inferior a cero.
  
  No use <strong>Memcache::decrement()</strong> en un valor, que fué guardado con compresión, porque en este caso
  <strong>Memcache::get()</strong> no funcionará.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    Clave del valor a decrementar.
  <info>int</info>     <strong>$value</strong>  Decrementar el valor según el <strong>$value</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>Memcache::increment()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::delete
type: function
doc:
<comment>Description:</comment>
  Elimina un valor del servidor
  
  <strong>Memcache::delete()</strong> elimina el valor según la clave <strong>$key</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      La clave asociada con el valor a eliminar.
  <info>int</info>     <strong>$timeout</strong>  Este parámetro ya no está soportado, y su valor por omisión es <return>0</return> segundos. No se
                    debe usar este parámetro.

<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>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::flush
type: function
doc:
<comment>Description:</comment>
  Limpia todos los valores existentes en el servidor
  
  <strong>Memcache::flush()</strong> invalida inmediatamente todos los valores existentes. <strong>Memcache::flush()</strong> no
  libera recursos del sistema, solamente marca los valores como expirados, la memoria que ahora se
  ocupa será sobreescrita por los nuevos valores. También se puede usar la función
  <strong>memcache_flush()</strong>.

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


id: Memcache::get
type: function
doc:
<comment>Description:</comment>
  Obtener valor del servidor
  
  <strong>Memcache::get()</strong> devuelve los datos previamente almacenados si el valor con la <strong>$key</strong> existe en el
  servidor en este momento.
  
  Se puede pasar un array de llaves a <strong>Memcache::get()</strong> para  obtener un array de valores. El
  resultado del array contendrá solamente  las parejas llave-valor encontradas.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    La llave o array de llaves a capturar.
  <info>int</info>     <strong>$flags</strong>  Si está presente, las flags capturadas juntamente con los valores serán escritas
                  en este parámetro. Estas flags son las mismas que las dadas por ejemplo en
                  <strong>Memcache::set()</strong>. El byte más bajo del entero está reservado para uso interno de
                  pecl/memcache (ej. para estado de compresión y serialización).

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena asociada con la clave dada por <strong>$key</strong> o un array de pares clave-valor
          cuando <strong>$key</strong> es un <info>array</info>. Devuelve <info>false</info> en caso de error, <strong>$key</strong> no se encuentra, o <strong>$key</strong> es
          un <info>array</info> vacío.


id: Memcache::getExtendedStats
type: function
doc:
<comment>Description:</comment>
  Obtener estadísticas de todos los servidores en el grupo
  
  <strong>Memcache::getExtendedStats()</strong> devuelve un array asociativo  de dos dimensiones con estadísticas del
  servidor(es). Las llaves del array  corresponden al servidor:puerto y los valores contienen las
  estadísticas  de cada servidor. En caso de error el servidor tendrá su correspondiente entrada
  asignada a <info>false</info>.   También puede usar la función <strong>memcache_get_extended_stats()</strong>.
  
  Esta función fue añadida en la versión 2.0.0. de Memcache.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>    Tipo de estadísticas a capturar. Valores válidos son {reset,  malloc, maps,
                   cachedump, slabs, items, sizes}. Según la especificación del protocolo de
                   memcached estos son los  argumentos adicionales "pueden estar sujetos a cambios
                   por  conveniencia de los desarrolladores de memcache".
  <info>int</info>     <strong>$slabid</strong>  Usado en conjunto con cachedump en el <strong>$type</strong>  para identificar el slap desde donde
                   volcar. El comando cachedump va en conjunto con el servidor y debe ser usado
                   estrictamente para propósitos de depuración.
  <info>int</info>     <strong>$limit</strong>   Usado en conjunto con cachedump en el <strong>$type</strong>  para limitar el número de entradas a
                   volcar.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array asociativo de dos dimensiones con las estadísticas o <info>false</info> en caso de
         error.

<comment>See Also:</comment>
   * <strong>Memcache::getVersion()</strong>
   * <strong>Memcache::getStats()</strong>


id: Memcache::getServerStatus
type: function
doc:
<comment>Description:</comment>
  Devuelve el estado del servidor
  
  <strong>Memcache::getServerStatus()</strong> devuelve el estado online/offline del servidor. También se puede usar
  la función <strong>memcache_get_server_status()</strong>.
  
  Esta función fue añadida en la versión 2.1.0. de Memcache.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Apunta al servidor donde memcached está esperando conexiones.
  <info>int</info>     <strong>$port</strong>  Apunta al puerto donde mecached está esperando conexiones.

<comment>Return:</comment>
  <info>int</info>  Devuelve el estado del servidor. 0 si el servidor devolvió un error, de lo contrario no
       devolverá cero.

<comment>See Also:</comment>
   * <strong>Memcache::addServer()</strong>
   * <strong>Memcache::setServerParams()</strong>


id: Memcache::getStats
type: function
doc:
<comment>Description:</comment>
  Obtiene estadísticas del servidor
  
  <strong>Memcache::getStats()</strong> devuelve un array asociativo con las estadísticas del servidor. Las llaves
  del array corresponden a los parámetros de las estadísticas y los valores a los valores de los
  parámetros. También se puede usar la función <strong>memcache_get_stats()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>    Tipo de estadísticas a capturar. Valores válidos son {reset,  malloc, maps,
                   cachedump, slabs, items, sizes}. Según la especificación del protocolo de
                   memcached estos son los  argumentos adicionales "pueden estar sujetos a cambios
                   por  conveniencia de los desarrolladores de memcache".
  <info>int</info>     <strong>$slabid</strong>  Usado en conjunto con cachedump en el <strong>$type</strong>  para identificar el slap desde donde
                   volcar. El comando cachedump va en conjunto con el servidor y debe ser usado
                   estrictamente para propósitos de depuración.
  <info>int</info>     <strong>$limit</strong>   Usado en conjunto con cachedump en el <strong>$type</strong>  para limitar el número de entradas a
                   volcar.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array asociativo con las estadísticas del servidor o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>Memcache::getVersion()</strong>
   * <strong>Memcache::getExtendedStats()</strong>


id: Memcache::getVersion
type: function
doc:
<comment>Description:</comment>
  Devuelve la versión del servidor
  
  <strong>Memcache::getVersion()</strong> devuelve una cadena con el número de  la versión del servidor. También
  puede usar la función <strong>memcache_get_version()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena con el número de la versión del servidor o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>Memcache::getExtendedStats()</strong>
   * <strong>Memcache::getStats()</strong>


id: Memcache::increment
type: function
doc:
<comment>Description:</comment>
  Incrementa numéricamente un valor
  
  <strong>Memcache::increment()</strong> incrementa el valor según el <strong>$value</strong>. Si el valor con la <strong>$key</strong> no es numérico
  y no se puede convertir a  número, cambiará su valor a <strong>$value</strong>. <strong>Memcache::increment()</strong> no creará el
  valor si no existe.  No use <strong>Memcache::increment()</strong> en un valor, que fué guardado con compresión,
  porque en este caso <strong>Memcache::get()</strong> no funcionará.  También se puede usar la función
  <strong>memcache_increment()</strong>.
  
  No use <strong>Memcache::increment()</strong> en un valor, que fué guardado con compresión, porque en este caso
  <strong>Memcache::get()</strong> no funcionará.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    Clave del valor a incrementar.
  <info>int</info>     <strong>$value</strong>  Incrementar el valor por <strong>$value</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>Memcache::decrement()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::pconnect
type: function
doc:
<comment>Description:</comment>
  Abre una conexión persistente a memcached
  
  <strong>Memcache::pconnect()</strong> es similar a  <strong>Memcache::connect()</strong> con la diferencia que la conexión que
  establece es persistente. La conexión no se cierra al finalizar el script o usando la función
  <strong>Memcache::close()</strong>. También se puede usar la función <strong>memcache_pconnect()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     Apunta al host donde memcache está esperando conexiones. En este parámetro quizá
                    puede especificar otros transportes como <return>unix:///path/to/memcached.sock</return> para
                    usar UNIX domain sockets, en este caso. <strong>$port</strong> debe establecerse  a <return>0</return>.
  <info>int</info>     <strong>$port</strong>     Apunta al puerto donde memcache está esperando conexiones. Estableza este
                    parámetro a <return>0</return> cuando se use UNIX domain sockets.
  <info>int</info>     <strong>$timeout</strong>  Valor en segundos que serán usandos para conectar al demonio. Piénselo dos veces
                    antes de cambiar el valor por defecto a 1 segundo. Se pueden perder todas las
                    ventajas del caché si la conexión es muy lenta.

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

<comment>See Also:</comment>
   * <strong>Memcache::connect()</strong>


id: Memcache::replace
type: function
doc:
<comment>Description:</comment>
  Reemplaza el valor de un valor existente
  
  <strong>Memcache::replace()</strong> debe ser usado para reemplazar el valor de un valor existente en una <strong>$key</strong>
  determinada. En caso que la  llave no exista, <strong>Memcache::replace()</strong> devolverá  <info>false</info>. Por lo demás
  <strong>Memcache::replace()</strong> funciona similar a <strong>Memcache::set()</strong>. También se puede usar la función
  <strong>memcache_replace()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     La clave que será asociada con el valor.
  <info>mixed</info>   <strong>$var</strong>     La variable a guardar. Cadenas y enteros son guardados tal y como son, otros
                   tipos son guardados de forma serializada.
  <info>int</info>     <strong>$flag</strong>    Utilice <info>MEMCACHE_COMPRESSED</info> para guardar el valor de forma comprimida (utiliza
                   zlib).
  <info>int</info>     <strong>$expire</strong>  Tiempo de expiración del valor. Si es igual a cero, el valor nunca expirará.
                   También se puede usar Unix timestamp o el número de segundos empezando desde de
                   hora actual, pero como máximo el número de segundos no debe exceder de  2592000
                   (30 días).

<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>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::add()</strong>


id: Memcache::set
type: function
doc:
<comment>Description:</comment>
  Guarda datos en el servidor
  
  <strong>Memcache::set()</strong> guarda un valor  <strong>$var</strong> con una <strong>$key</strong> en el  servidor memcached. El parámetro <strong>$expire</strong>
  es el tiempo de expiración en segundos. Si es 0, el valor nunca expira (pero el servidor memcached
  no garantiza que este valor será guardado para siempre, puede ser eliminado de la caché para hacer
  espacio para otros valores). Se puede usar la constante <info>MEMCACHE_COMPRESSED</info> en el valor del <strong>$flag</strong>
  si quiere utilizar compresión al momento (usando zlib).  Recuerde que variables de recursos (ej.
  ficheros y descriptores de conexiones) no pueden guardarse en caché, porque no pueden ser
  representados adecuadamente de forma serializada.     También se puede usar la función
  <strong>memcache_set()</strong>.
  
  Recuerde que variables de recursos (ej. ficheros y descriptores de conexiones) no pueden guardarse
  en caché, porque no pueden ser representados adecuadamente de forma serializada.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     La clave que quedará asociada con el valor.
  <info>mixed</info>   <strong>$var</strong>     La variable a guardar. Cadenas y enteros se guardan tal y como son,  otros tipos
                   se guardan serializados.
  <info>int</info>     <strong>$flag</strong>    Use <info>MEMCACHE_COMPRESSED</info> para guardar datos comprimidos (usa zlib).
  <info>int</info>     <strong>$expire</strong>  Tiempo de expiración del valor. Si es iqual a cero, el valor nunca expirará.
                   También puedes usar Unix timestamp o el número de segundos empezando desde la
                   fecha actual, el valor no puede exceder de  2592000 segundos (30 días).

<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>
   * <strong>Memcache::add()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::setCompressThreshold
type: function
doc:
<comment>Description:</comment>
  Activa compresión automática de valores con datos largos
  
  <strong>Memcache::setCompressThreshold()</strong> activa compresión automática de  valores largos. También se puede
  usar la función <strong>memcache_set_compress_threshold()</strong>.
  
  Esta función fue añadida en la versión 2.0.0. de Memcache.

<comment>Param:</comment>
  <info>int</info>  <strong>$threshold</strong>   Controla la longitud valor mínimo antes de intentar comprimir automáticamente.
  <info></info>     <strong>$min_saving</strong>  Especifica la cantidad mínima del ratio de compresión para  guardar el valor. El
                    valor debe ser entre 0 y 1. Por defecto es de 0,2 un mínimo de 20% de ratio de
                    compresión.

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


id: Memcache::setServerParams
type: function
doc:
<comment>Description:</comment>
  Cambia parámetros del servidor y estado en tiempo de ejecucción
  
  <strong>Memcache::setServerParams()</strong> cambia parámetros del servidor en tiempo de ejecucción. También se
  puede usar la función <strong>memcache_set_server_params()</strong>.
  
  Esta función fue añadida en la versión 2.1.0. de Memcache.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>              Apunta al host donde memcached está esperando conexiones.
  <info>int</info>       <strong>$port</strong>              Apunta al puerto donde memcached está esperando conexiones.
  <info>int</info>       <strong>$timeout</strong>           Valor en segundos que se utilizarán para conectarse al demonio.
                               Piensa dos veces antes de cambiar el valor por defecto de 1 segundo,
                               puedes perder todas la ventajas del caché si tus conexiones son muy
                               lentas.
  <info>int</info>       <strong>$retry_interval</strong>    Controla la frecuencia de reintentos cuando falla la conexión, el
                               valor por defecto es  15 segundos. Si establece este parámetro a -1
                               desactivará el reintento automático. Ni esta opción ni el parámetro
                               <strong>$persistent</strong> tienen ningún efecto cuando la extensión se carga
                               dinámicamente a través de <strong>dl()</strong>.
  <info>bool</info>      <strong>$status</strong>            Controla si el servidor debe ser marcado como online. Estableciendo
                               este parámetro a <info>false</info> y <strong>$retry_interval</strong> a -1 permite a un servidor
                               que falle a ser mantenido en el grupo para no afectar el algoritmo de
                               distribución de llaves. Las peticiones a este servidor fallarán
                               inmediatamente dependiendo en la opción <strong>$memcache.allow_failover</strong>. Por
                               defecto to <info>true</info>, que significa que el servidor se considera online.
  <info>callable</info>  <strong>$failure_callback</strong>  Permite al usuario a especificar la llamada a una función de retorno
                               a ejectuar cuando se encuentre un error. La llamada de retorno se
                               ejecuta antes de que se produzca la  caída en la conexión. La función
                               toma dos parámetros, el hostname y el puerto del puerto que ha
                               fallado.

<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>
   * <strong>Memcache::addServer()</strong>
   * <strong>Memcache::getServerStatus()</strong>


id: Memcached
type: class
doc:
<comment>Description:</comment>
  Representa una conexión a un conjunto de servidores de memcached.


id: Memcached::DISTRIBUTION_CONSISTENT
type: constant
doc:
<comment>Description:</comment>
  Algoritmo de distribución de claves hash consistentes (basado en libketama).


id: Memcached::GET_PRESERVE_ORDER
type: constant
doc:
<comment>Description:</comment>
  Opción para <strong>Memcached::getMulti()</strong> y <strong>Memcached::getMultiByKey()</strong> para garantizar que las claves son
  devueltas en el mismo orden que fueron solicitadas. Las claves no existentes obtienen un valor
  predeterminado de NULL.


id: Memcached::HASH_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Algoritmo hash predeterminado (Jenkins una-cada-vez) de claves de ítems.


id: Memcached::HAVE_IGBINARY
type: constant
doc:
<comment>Description:</comment>
  Indica si está disponible el soporte para el serializador igbinary.
  
  Tipo: <return>boolean</return>.


id: Memcached::HAVE_JSON
type: constant
doc:
<comment>Description:</comment>
  Indica si está disponible el soporte para el serializador JSON.
  
  Tipo: <return>boolean</return>.


id: Memcached::OPT_BINARY_PROTOCOL
type: constant
doc:
<comment>Description:</comment>
  Activa el empleo del protocolo binario. Observe que no se puede cambiar esta opción cuando una
  conexión está abierta.
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::OPT_BUFFER_WRITES
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva la E/S en búfer. Activar la E/S en búfer hace que los comandos de
  almacenamiento usen el búfer en lugar de ser enviados. Cualquier acción que obtenga datos hace que
  la información del búfer sea enviada a la conexión remota. El quitar o cerrar la conexión también
  ocasionará que los datos del búfer sean enviados a la conexión remota.
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::OPT_CACHE_LOOKUPS
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva caché para resoluciones DNS.
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::OPT_COMPRESSION
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva la compresión de la carga. Cuando está activada, los valores de ítems mayores
  que cierto umbral (actualmente 100 bytes) serán comprimidos durante el almacenamiento y
  descomprimidos durante su recuperación de forma transparente.
  
  Tipo: <return>boolean</return>, predeterminado: <info>true</info>.


id: Memcached::OPT_CONNECT_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  En el modo de no bloqueo, establecer el valor del tiempo de espera durante la conexión al socket,
  en milisengundos.
  
  Tipo: <return>integer</return>, predeterminado: <return>1000</return>.


id: Memcached::OPT_DISTRIBUTION
type: constant
doc:
<comment>Description:</comment>
  Especifica el método para distribuir claves de ítems en los servidores. Actualmente, los métodos
  admitidos son módulo y hash consistente. El hash consistente proporciona una mejor distribución y
  permite que los servidores sean añadidos al clúster con el mínimo de pérdidas de caché.
  
  Tipo: <return>integer</return>, predeterminado: <info>Memcached::DISTRIBUTION_MODULA.</info>


id: Memcached::OPT_HASH
type: constant
doc:
<comment>Description:</comment>
  Especifica el algoritmo hash utilizado por las claves de ítems. Los valores válidos se
  proporcionan mediante las constantes <info>Memcached::HASH_*</info>. Cada algoritmo hash tiene sus ventajas y
  desventajas. Se deberá utilizar el predeterminado si no se tiene conocimiento o no tiene
  relevancia.
  
  Tipo: <return>integer</return>, predeterminado: <info>Memcached::HASH_DEFAULT</info>


id: Memcached::OPT_LIBKETAMA_COMPATIBLE
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva la compatibilidad con el comportamiento de libketama. Cuando está activada, el
  algoritmo hash de claves de ítems se establece a MD5 y la distribución se establece a la
  distribución de hash consistente compensada. Esto es útil debido a que otros clientes basados en
  libketama (Python, Ruby, etc.) con la misma configuración de servidor serán capaces de acceder a
  las claves de forma transparente.
  
  Es muy recomendable activar esta opción para el empleo de hash consistente, y seguramente estará
  activada de forma predeterminada en  futuras versiones.
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::OPT_NO_BLOCK
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva la E/S asíncrona. Es el transporte más rápido disponible para funciones de
  almacenamiento.
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::OPT_POLL_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Tiempo de espera para el agrupamiento de conexiones, en milisegundos.
  
  Tipo: <return>integer</return>, predeterminado: <return>1000</return>.


id: Memcached::OPT_PREFIX_KEY
type: constant
doc:
<comment>Description:</comment>
  Puede emplearse para crear un "dominio" para las claves de ítems. El valor especificado será
  utilizado para prefijar cada una de las claves. No puede ser mayor que <return>128</return> caracteres y reducirá
  el  tamaño máximo disponible de la clave. El prefijo se aplica solamente a las claves de los
  ítems, no en las claves de servidores.
  
  Tipo: <return>string</return>, predeterminado: <return>""</return>.


id: Memcached::OPT_RECV_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Tiempo de espera para la lectura del socket, en microsegundos. En los casos donde no se puede
  emplear E/S de no bloqueo, permitirá tener tiempos de espera al leer datos.
  
  Tipo: <return>integer</return>, predeterminado: <return>0</return>.


id: Memcached::OPT_RETRY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  La cantidad de tiempo, en segundos, a esperar para reintentar la conexión en caso que haya
  fallado.
  
  Tipo: <return>integer</return>, predeterminado: <return>0</return>.


id: Memcached::OPT_SEND_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Tiempo de espera para el envío al socket, en microsegundos. En los casos donde no se puede emplear
  E/S de no bloqueo, permitirá tener tiempos de espera al enviar datos.
  
  Tipo: <return>integer</return>, predeterminado: <return>0</return>.


id: Memcached::OPT_SERIALIZER
type: constant
doc:
<comment>Description:</comment>
  Especifica el serializador a emplear para serializar valores no escalares. Los serializadores
  válidos son <info>Memcached::SERIALIZER_PHP</info> o <info>Memcached::SERIALIZER_IGBINARY</info>. Este último solo se admite
  cuando memcached está configurada con la opción <return>--enable-memcached-igbinary</return> y la extensión
  <return>igbinary</return> está cargada.
  
  Tipo: <return>integer</return>, predeterminado: <info>Memcached::SERIALIZER_PHP</info>.


id: Memcached::OPT_SERVER_FAILURE_LIMIT
type: constant
doc:
<comment>Description:</comment>
  Especifica el límite de intentos de conexión al servidor. El servidor será eliminado después del
  número indicado de fallos continuos de  conexión.
  
  Tipo: <return>integer</return>, predeterminado: <return>0</return>.


id: Memcached::OPT_SOCKET_RECV_SIZE
type: constant
doc:
<comment>Description:</comment>
  El búfer máximo de recepción de socket, en bytes.
  
  Tipo: <return>integer</return>, predeterminado: varía según la plataforma/configuración del kernel.


id: Memcached::OPT_SOCKET_SEND_SIZE
type: constant
doc:
<comment>Description:</comment>
  El búfer máximo de envío de socket, en bytes.
  
  Tipo: <return>integer</return>, predeterminado: varía según la plataforma/configuración del kernel.


id: Memcached::OPT_TCP_NODELAY
type: constant
doc:
<comment>Description:</comment>
  Activa o desactiva la característica de no retraso para conectar a un socket (podría ser más
  rápida en algunos entornos).
  
  Tipo: <return>boolean</return>, predeterminado: <info>false</info>.


id: Memcached::RES_DATA_EXISTS
type: constant
doc:
<comment>Description:</comment>
  Fallo al comparar e intercambiar: el ítem que se intenta guardar ha sido modificado desde la
  última vez que se obtuvo.


id: Memcached::RES_NOTFOUND
type: constant
doc:
<comment>Description:</comment>
  No se encontró el ítem con esta clave (mediante la operación "get"  o "cas").


id: Memcached::RES_NOTSTORED
type: constant
doc:
<comment>Description:</comment>
  El ítem no fue guardado: pero no a causa de un error. Normalmente significa que no se cumplió la
  condición para un comando "add" o "replace", o que el ítem está en una cola para su eliminación.


id: Memcached::RES_PAYLOAD_FAILURE
type: constant
doc:
<comment>Description:</comment>
  Error de carga: no se pudo comprimir/descomprimir o serializar/deserializar el valor.


id: Memcached::SERIALIZER_IGBINARY
type: constant
doc:
<comment>Description:</comment>
  El serializador de igbinary. En lugar de una representación textual, almacena estructuras de datos
  de PHP de una forma binaria compacta, lo que resulta en mejoras de espacio y tiempo.


id: Memcached::__construct
type: function
doc:
<comment>Description:</comment>
  Crear una instancia de Memcached
  
  Crea una instancia de Memcached que representa la conexión a los servidores de memcache.

<comment>Param:</comment>
  <info>string</info>  <strong>$persistent_id</strong>  Por defecto, las instancias de Memcached son destruidas al final de la
                          petición. Para crear una instancia que persista entre peticiones, use
                          <strong>$persistent_id</strong> para especificar un ID único para la  instancia. Todas las
                          instancias creadas con el mismo <strong>$persistent_id</strong> compartirán la misma
                          conexión.

<comment>Return:</comment>
  <info>unknown</info>  Un objeto Memcached.


id: Memcached::add
type: function
doc:
<comment>Description:</comment>
  Añade un ítem asociado a una nueva clave
  
  <strong>Memcached::add()</strong> es similar a Memcached::set, pero la operación fallará si <strong>$key</strong> ya existe en el
  servidor.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave ya existe.

<comment>See Also:</comment>
   * Memcached::addByKey
   * Memcached::set
   * Memcached::replace


id: Memcached::addByKey
type: function
doc:
<comment>Description:</comment>
  Añade un ítem asociado a una nueva clave en un servidor específico
  
  La funcionalidad de <strong>Memcached::addByKey()</strong> es equivalente a la de Memcached::add, con la excepción
  de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un servidor
  específico. Es útil si se necesita relacionar cierta cantidad de claves a un servidor determinado.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave ya existe.

<comment>See Also:</comment>
   * Memcached::add
   * Memcached::set
   * Memcached::replace


id: Memcached::addServer
type: function
doc:
<comment>Description:</comment>
  Añade un servidor a la provisión de servidores
  
  <strong>Memcached::addServer()</strong> añade el servidor especificado a la provisión de servidores. En esta
  operación no se establece una conexión al servidor, aunque si se emplea la opción de distribución
  de claves (a través de <info>Memcached::DISTRIBUTION_CONSISTENT</info> o <info>Memcached::OPT_LIBKETAMA_COMPATIBLE</info>),
  algunas de las  estructuras de datos internas deberán ser actualizadas. Así, si fuera necesario
  añadir varios servidores, es mejor utilizar Memcached::addServers, ya que la actualización se
  realiza  una única vez.
  
  El mismo servidor podría aparecer varias veces en la provisión de servidores, debido a que no se
  realiza ninguna comprobación de duplicados. Esta característica no es aconsejable; emplee en su
  lugar la opción <strong>$weight</strong> para aumentar el peso de selección (importancia) de dicho servidor.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>    El nombre de host del servidor de memcache. Si el nombre de host no es válido,
                   las operaciones relacinadas con datos establecerán el código de resultado
                   <info>Memcached::RES_HOST_LOOKUP_FAILURE</info>. A partir de la versión 2.0.0b1, este
                   parámetro puede también especificar la ruta de un socket de unix, p.ej.,
                   <return>/ruta/a/memcached.sock</return>, para emplear socket de dominio de UNIX; en este caso
                   también se debe establecer <strong>$port</strong> a <return>0</return>.
  <info>int</info>     <strong>$port</strong>    El puerto en que memcache está funcionado. Normalmente es <return>11211</return>. A partir de la
                   versión 2.0.0b1, se debe establecer este parámetro a <return>0</return> al utilizar socket de
                   dominio UNIX.
  <info>int</info>     <strong>$weight</strong>  El peso (importancia) del servidor relativo al peso total de todos los servidores
                   en la provisión. Controla la probabilidad de que un servidor sea elegido para
                   realizar operaciones. Solamente se utiliza para la opción de  distribución
                   consistente y normalmente corresponde a la cantidad de memoria disponible para
                   memcache en dicho servidor.

<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>
   * Memcached::addServers
   * Memcached::resetServerList


id: Memcached::addServers
type: function
doc:
<comment>Description:</comment>
  Añadir varios servidores a la agrupación de servidores
  
  <strong>Memcached::addServers()</strong> añade <strong>$servers</strong> a la agrupación de servidores. Cada entrada de  <strong>$servers</strong>
  debe ser un array que contenga el nombre de host, el puerto y, opcionalmente, el peso
  (importancia) del servidor. No se establecerá ninguna conexión a los servidores en este proceso.
  
  El mismo servidor podría aparecer varias veces en la agrupación de servidores, debido a que no se
  realiza ninguna comprobación de duplicados. Esta característica  no es aconsejable; emplee en su
  lugar la opción <strong>$weight</strong> para aumentar el peso de selección (importancia) de dicho servidor.

<comment>Param:</comment>
  <info></info>  <strong>$array</strong>  Array de servidores a añadir a la agrupación de servidores.

<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>
   * Memcached::addServer
   * Memcached::resetServerList


id: Memcached::append
type: function
doc:
<comment>Description:</comment>
  Añadir datos a un ítem existente
  
  <strong>Memcached::append()</strong> añade el string dado por <strong>$value</strong> al valor del ítem existente. La razón por la
  que se fuerza a <strong>$value</strong> a ser un string es debido a que no está bien definida la adición de tipos
  mixtos.
  
  Si <info>Memcached::OPT_COMPRESSION</info> está activado, la operación fallará y se emitirá una advertencia, ya
  que no es posible añadir datos comprimidos a un valor que potencialmente ya está comprimido.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    La clave en la que se guardará el valor.
  <info>string</info>  <strong>$value</strong>  El string 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. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::appendByKey
   * Memcached::prepend


id: Memcached::appendByKey
type: function
doc:
<comment>Description:</comment>
  Añadir datos a un ítem existente en un servidor específico
  
  La funcionalidad de <strong>Memcached::appendByKey()</strong> es equivalente a la de Memcached::append, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>string</info>  <strong>$value</strong>       El string 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. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si clave no existe.

<comment>See Also:</comment>
   * Memcached::append
   * Memcached::prepend


id: Memcached::cas
type: function
doc:
<comment>Description:</comment>
  Comparar e intercambiar un ítem
  
  <strong>Memcached::cas()</strong> realiza una operación "comprobar y establecer" ('cas' por sus siglas en inglés),
  de forma que el ítem será guardado solamente si ningún otro cliente lo actualizó desde la última
  vez que este cliente lo obtuvo. La comprobación se realiza mediante el parámetro <strong>$cas_token</strong>, el
  cual es un valor único de 64 bit asignado al ítem existente por memcache. Ver la documentación de
  los métodos Memcached::get* para saber cómo obtener este token. Observar que el token está
  representado como un valor de tipo double debido a las limitaciones de espacio para valores
  integer de PHP.

<comment>Param:</comment>
  <info>float</info>   <strong>$cas_token</strong>   El valor único asociado con el ítem existente. Generado por memcache.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_DATA_EXISTS</info> si el ítem que se trata de guardar ha sido modificado desde la
        última vez que se obtuvo.

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


id: Memcached::casByKey
type: function
doc:
<comment>Description:</comment>
  Comparar e intercambiar un ítem en un servidor específico
  
  La funcionalidad de <strong>Memcached::casByKey()</strong> es equivalente a la de Memcached::cas, con la excepción
  de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un servidor
  específico. Es útil si se necesita relacionar cierta cantidad de claves a un servidor determinado.

<comment>Param:</comment>
  <info>float</info>   <strong>$cas_token</strong>   Valor único asociado con el ítem existente. Generado por memcache.
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_DATA_EXISTS</info> si el ítem que se trata de guardar ha sido modificado desde la
        última vez que se obtuvo.

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


id: Memcached::decrement
type: function
doc:
<comment>Description:</comment>
  Decrementar un valor numérico de un ítem
  
  <strong>Memcached::decrement()</strong> decrementa un valor numérico de un ítem por el <strong>$offset</strong> especificado. Si el
  valor del ítem no es numérico, generará un error. Si la operación requiere decrementar un valor
  inferior a 0, el nuevo valor será 0. <strong>Memcached::decrement()</strong> establecerá el ítem al parámetro
  <strong>$initial_value</strong> si la clave no existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>            La clave del ítem a decrementar.
  <info>int</info>     <strong>$offset</strong>         La cantidad por la que decrementar el valor del ítem.
  <info>int</info>     <strong>$initial_value</strong>  El valor para establecer el ítem si actualmente no existe.
  <info>int</info>     <strong>$expiry</strong>         El periodo de expiración a establecer para el ítem.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor del ítem en caso de éxito  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Memcached::increment
   * Memcached::incrementByKey
   * Memcached::decrementByKey


id: Memcached::decrementByKey
type: function
doc:
<comment>Description:</comment>
  Decrementar un valor numérico de un ítem almacenado en un servidor específico
  
  <strong>Memcached::decrementByKey()</strong> decrementa un valor numérico de un ítem por el <strong>$offset</strong> especificado.
  Si el valor del ítem no es numérico, generará un error. Si la operación requiere decrementar un
  valor inferior a 0, el nuevo valor será 0. <strong>Memcached::decrement()</strong> establecerá el ítem al parámetro
  <strong>$initial_value</strong> si la clave no existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>     La clave que identifica al servidor donde guardar o recuperar el valor. En
                          lugar de realizar un hash en la clave real para el ítem, se realiza en la
                          clave del servidor cuando se decide con qué servidor de memcached
                          conversar. Esto permite que los ítems relacionados sean agrupados en un
                          único servidor para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>            La clave del ítem a decrementar.
  <info>int</info>     <strong>$offset</strong>         La cantidad por la que decrementar el valor del ítem.
  <info>int</info>     <strong>$initial_value</strong>  El valor para establecer el ítem si actualmente no existe.
  <info>int</info>     <strong>$expiry</strong>         El periodo de expiración a establecer para el ítem.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor del ítem en caso de éxito  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::increment
   * Memcached::incrementByKey


id: Memcached::delete
type: function
doc:
<comment>Description:</comment>
  Eliminar un ítem
  
  <strong>Memcached::delete()</strong> elimina el array de claves dado por <strong>$keys</strong> del servidor. El parámetro <strong>$time</strong> es
  la cantidad de tiempo en segundos (o el instante Unix a sobrepasar) por el cual el cliente quiere
  que el servidor rechace los comandos <return>add</return> y <return>replace</return> para estas claves. El ítem es puesto en una
  cola de eliminación por esta cantidad de tiempo, los que significa que no será posible recuperarlo
  por el comando <return>get</return>, y que el empleo de los comandos <return>add</return> y <return>replace</return> con tales claves también
  fallarán (aunque el comando <return>set</return> sí funcionará). Finalizado el tiempo, el ítem es por fin eliminado
  de la memoria del servidor. El parámetro <strong>$time</strong> es por defecto 0 (lo que significa que el ítem será
  eliminado de inmediato y que tendrán éxito los comandos de almacenamiento posteriores con estas
  claves).

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>   La clave a eliminar.
  <info>int</info>     <strong>$time</strong>  La cantidad de tiempo que el servidor esperará para borrar el ítem.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTFOUND</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::deleteByKey
   * Memcached::deleteMulti


id: Memcached::deleteByKey
type: function
doc:
<comment>Description:</comment>
  Eliminar un ítem de un servidor específico
  
  La funcionalidad de <strong>Memcached::deleteByKey()</strong> es equivalente a la de Memcached::delete, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave a eliminar.
  <info>int</info>     <strong>$time</strong>        La cantidad de tiempo que el servidor esperará para eliminar el ítem.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTFOUND</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteMulti
   * Memcached::deleteMultiByKey


id: Memcached::deleteMulti
type: function
doc:
<comment>Description:</comment>
  Eliminar varios ítems
  
  <strong>Memcached::deleteMulti()</strong> elimina el array de claves dado por <strong>$keys</strong> del servidor. El parámetro
  <strong>$time</strong> es la cantidad de tiempo en segundos (o el instante Unix a sobrepasar) por el cual el
  cliente quiere que el servidor rechace los comandos <return>add</return> y <return>replace</return> para estas claves. El ítem es
  puesto en una cola de eliminación por esta cantidad de tiempo, los que significa que no será
  posible recuperarlo por el comando <return>get</return>, y que el empleo de los comandos <return>add</return> y <return>replace</return> con tales
  claves también fallarán (aunque el comando <return>set</return> sí funcionará). Finalizado el tiempo, el ítem es
  por fin eliminado de la memoria del servidor. El parámetro <strong>$time</strong> es por defecto 0 (lo que
  significa que el ítem será eliminado de inmediato y que tendrán éxito los comandos de
  almacenamiento posteriores con estas claves).

<comment>Param:</comment>
  <info>array</info>  <strong>$keys</strong>  Las claves a eliminar.
  <info>int</info>    <strong>$time</strong>  La cantidad de tiempo que el servidor esperará para borrar los ítems.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTFOUND</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteByKey
   * Memcached::deleteMultiByKey


id: Memcached::deleteMultiByKey
type: function
doc:
<comment>Description:</comment>
  Eliminar varios ítems de un servidor específico
  
  La funcionalidad de <strong>Memcached::deleteMultiByKey()</strong> es equivalente a la de Memcached::deleteMulti,
  con la excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda
  a un servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>array</info>   <strong>$keys</strong>        Las claves a eliminar.
  <info>int</info>     <strong>$time</strong>        La cantidad de tiempo que esperará el servidor para eliminar los ítems.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTFOUND</info> si clave no existe.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteByKey
   * Memcached::deleteMulti


id: Memcached::fetch
type: function
doc:
<comment>Description:</comment>
  Obtener el siguiente resultado
  
  <strong>Memcached::fetch()</strong> obtiene el siguiente resultado de la última petición.

<comment>Return:</comment>
  <info>array</info>  Devuelve el siguiente resultado o <info>false</info> en caso contrario. Memcached::getResultCode
         devolverá <info>Memcached::RES_END</info> si el conjunto de resultados se ha agotado.

<comment>See Also:</comment>
   * Memcached::fetchAll
   * Memcached::getDelayed


id: Memcached::fetchAll
type: function
doc:
<comment>Description:</comment>
  Obtener todos los resultados restantes
  
  <strong>Memcached::fetchAll()</strong> obtiene todos los resultados restantes de la última petición.

<comment>Return:</comment>
  <info>array</info>  Devuelve los resultados  o <info>false</info> en caso de error. Emplee Memcached::getResultCode si fuera
         necesario.

<comment>See Also:</comment>
   * Memcached::fetch
   * Memcached::getDelayed


id: Memcached::flush
type: function
doc:
<comment>Description:</comment>
  Invalidar todos los ítems de la caché
  
  <strong>Memcached::flush()</strong> invalida todos los ítems existentes en la caché de forma inmediata (lo
  predeterminado) o después de una demora especificada por <strong>$delay</strong>. Después de la invalidación, no se
  devolverá ninún ítem en respuesta a un comando de obtención (a no ser que se haya guardado de
  nuevo bajo la misma clave después de que <strong>Memcached::flush()</strong> haya invalidado los ítems). El vaciado
  no libera la memoria ocupada por todos los ítems existentes; esto irá sucediendo a medida que se
  vayan guardando nuevos ítems.

<comment>Param:</comment>
  <info>int</info>  <strong>$delay</strong>  El número de segundos a esperar antes de invalidar los ítems.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.


id: Memcached::get
type: function
doc:
<comment>Description:</comment>
  Obtener un ítem
  
  <strong>Memcached::get()</strong> devuelve el ítem que fue previamente guardado bajo la clave dada por <strong>$key</strong>. Si se
  encuentra el ítem y se proporciona la variable <strong>$cas_token</strong>, esta contendrá el valor del token CAS
  para el ítem. Ver Memcached::cas para saber cómo utilizar los token CAS. Se podrían especificar
  Retrollamadas de caché de lectura previa mediante el parámetro <strong>$cache_cb</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$key</strong>        La clave del ítem a obtener.
  <info>callable</info>  <strong>$cache_cb</strong>   La retrollamada de caché de lectura previa o <info>null</info>.
  <info>float</info>     <strong>$cas_token</strong>  La variable donde guardar el token CAS.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor almacenado en caché o <info>false</info> en caso contrario. Memcached::getResultCode
         devolverá <info>Memcached::RES_NOTFOUND</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::getByKey
   * Memcached::getMulti
   * Memcached::getDelayed


id: Memcached::getAllKeys
type: function
doc:
<comment>Description:</comment>
  Obtiene las claves almacenadas en todos los servidores
  
  <strong>Memcached::getAllKeys()</strong> consulta cada servidor de memcache y recupera un array con todas las
  claves almacenadas en ellos en ese instante. Esta no es una operación atómica, por lo que no es
  una instantánea realmente consistente de las claves en ese momento. Debido a que memcache no
  garantiza la devolución de todas las claves, no se podrá asumir que han sido devueltas en su
  totalidad.

<comment>Return:</comment>
  <info>array</info>  Devuelve las claves almacenadas en todos los servidores en caso de éxito  o <info>false</info> en caso
         de error.


id: Memcached::getByKey
type: function
doc:
<comment>Description:</comment>
  Obtiene un ítem de un servidor específico
  
  La funcionalidad de <strong>Memcached::getByKey()</strong> es equivalente a la de Memcached::get, con la excepción
  de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un servidor
  específico.

<comment>Param:</comment>
  <info>string</info>    <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                         lugar de realizar un hash en la clave real para el ítem, se realiza en la
                         clave del servidor cuando se decide con qué servidor de memcached
                         conversar. Esto permite que los ítems relacionados sean agrupados en un
                         único servidor para una mayor eficacia con operaciones múltiples.
  <info>string</info>    <strong>$key</strong>         La clave del ítem a obtener.
  <info>callable</info>  <strong>$cache_cb</strong>    La retrollamada de caché de lectura previa o <info>null</info>.
  <info>float</info>     <strong>$cas_token</strong>   La variable donde guardar el token CAS.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor guardado en caché o <info>false</info> en caso contrario. Memcached::getResultCode
         devolverá <info>Memcached::RES_NOTFOUND</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::get
   * Memcached::getMulti
   * Memcached::getDelayed


id: Memcached::getDelayed
type: function
doc:
<comment>Description:</comment>
  Obtener varios ítems
  
  <strong>Memcached::getDelayed()</strong> envía una petición a memcache de varios ítems con las claves que se
  especifican en el array <strong>$keys</strong>. El método no espera una respuesta y devuelve inmediatamente. En
  cuanto se puedan obtener los ítems, se ha de llamar a Memcached::fetch o Memcached::fetchAll. Si
  <strong>$with_cas</strong> es true, los valores del token CAS también serán solicitados.
  
  En lugar de obtener los resultados explícitamente, se puede especificar una retrollamada de
  resultados mediante el parámetro <strong>$value_cb</strong>.

<comment>Param:</comment>
  <info>array</info>     <strong>$keys</strong>      Array de claves a solicitar.
  <info>bool</info>      <strong>$with_cas</strong>  Si solicitar también los valores del token CAS.
  <info>callable</info>  <strong>$value_cb</strong>  La retrollamada de resultados o <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

<comment>See Also:</comment>
   * Memcached::getDelayedByKey
   * Memcached::fetch
   * Memcached::fetchAll


id: Memcached::getDelayedByKey
type: function
doc:
<comment>Description:</comment>
  Solicitar varios ítems de un servidor específico
  
  La funcionalidad de <strong>Memcached::getDelayedByKey()</strong> es equivalente a la de Memcached::getDelayed, con
  la excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>    <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                         lugar de realizar un hash en la clave real para el ítem, se realiza en la
                         clave del servidor cuando se decide con qué servidor de memcached
                         conversar. Esto permite que los ítems relacionados sean agrupados en un
                         único servidor para una mayor eficacia con operaciones múltiples.
  <info>array</info>     <strong>$keys</strong>        Array de claves a solicitar.
  <info>bool</info>      <strong>$with_cas</strong>    Si solicitar también los valores del token CAS.
  <info>callable</info>  <strong>$value_cb</strong>    La retrollamada de resultados o <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

<comment>See Also:</comment>
   * Memcached::getDelayed
   * Memcached::fetch
   * Memcached::fetchAll


id: Memcached::getMulti
type: function
doc:
<comment>Description:</comment>
  Obtener varios ítems
  
  <strong>Memcached::getMulti()</strong> es similar a  Memcached::get, pero en lugar de un único ítem de clave,
  obtiene varios ítems cuyas claves se especifican en el array  <strong>$keys</strong>. Si se proporciona la variable
  <strong>$cas_tokens</strong>, esta contendrá los token CAS para los  ítems que se hayan encontrado.  A diferencia
  de Memcached::get no es posible  especificar una retrollamada de caché de lectura previa para
  <strong>Memcached::getMulti()</strong>, porque el protocolo memcache no provee información de las claves que no se
  encontraron en la petición de claves múltiple.
  
  A diferencia de Memcached::get no es posible  especificar una retrollamada de caché de lectura
  previa para <strong>Memcached::getMulti()</strong>, porque el protocolo memcache no provee información de las
  claves que no se encontraron en la petición de claves múltiple.
  
  El parámetro <strong>$flags</strong> se puede emplear para especificar opciones adicionales para
  <strong>Memcached::getMulti()</strong>. Actualmente, la única opción disponible es <info>Memcached::GET_PRESERVE_ORDER</info>,
  que garantiza que las claves sean devueltas en el mismo orden en que fueron solicitadas.

<comment>Param:</comment>
  <info>array</info>  <strong>$keys</strong>        Array de claves a obtener.
  <info>array</info>  <strong>$cas_tokens</strong>  La variable donde guardar los token CAS de los ítems encontrados.
  <info>int</info>    <strong>$flags</strong>       Los indicadores para la operación de obtención (get).

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el array de ítems encontrados  o <info>false</info> en caso de error. Emplee
         Memcached::getResultCode si fuera necesario.

<comment>See Also:</comment>
   * Memcached::getMultiByKey
   * Memcached::get
   * Memcached::getDelayed


id: Memcached::getMultiByKey
type: function
doc:
<comment>Description:</comment>
  Recuperar varios ítems de un servidor específico
  
  La funcionalidad de <strong>Memcached::getMultiByKey()</strong> es equivalente a la de Memcached::getMulti, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>array</info>   <strong>$keys</strong>        Array de claves a obtener.
  <info>string</info>  <strong>$cas_tokens</strong>  La variables donde almacenar los token CAS de los ítems encontrados.
  <info>int</info>     <strong>$flags</strong>       Los indicadores para la operación de obtención (get).

<comment>Return:</comment>
  <info>array</info>  Devuelve el array de ítems encontrados  o <info>false</info> en caso de error. Emplee
         Memcached::getResultCode si fuera necesario.

<comment>See Also:</comment>
   * Memcached::getMulti
   * Memcached::get
   * Memcached::getDelayed


id: Memcached::getOption
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de una opción de Memcached
  
  Este método devuelve el valor de la opción de Memcached dada por <strong>$option</strong>. Algunas opciones se
  corresonden con las definidas por libmemcached, y otras son específicas de la extensión. Ver
  Constantes de Memcached para más información.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  Una de las constantes <info>Memcached::OPT_*</info>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor de la opción solicitada, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOption
   * Constantes de Memcached


id: Memcached::getResultCode
type: function
doc:
<comment>Description:</comment>
  Devuelve el código resultante de la última operación
  
  <strong>Memcached::getResultCode()</strong> devuelve una de las constantes <info>Memcached::RES_*</info>, la cual es el
  resultado del último método de Memcached ejecutado.

<comment>Return:</comment>
  <info>int</info>  El código resultante de la última operación de Memcached.


id: Memcached::getResultMessage
type: function
doc:
<comment>Description:</comment>
  Devolver un mensaje que describe el resultado de la última operación
  
  <strong>Memcached::getResultMessage()</strong> devuelve un string que describe el código resultante del último
  método de Memcached ejecutado.

<comment>Return:</comment>
  <info>string</info>  Un mensaje que describe el resultado de la última operación Memcached.


id: Memcached::getServerByKey
type: function
doc:
<comment>Description:</comment>
  Hacer corresponder una clave con un servidor
  
  <strong>Memcached::getServerByKey()</strong> devuelve el servidor que será seleccionado por una clave dada por
  <strong>$server_key</strong> en particular para todas las operaciones <strong>Memcached::*ByKey()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene tres claves: <return>host</return>, <return>port</return>, y <return>weight</return> en caso de éxito, o <info>false</info>
         en case de error. Emplee Memcached::getResultCode si fuera necesario.


id: Memcached::getServerList
type: function
doc:
<comment>Description:</comment>
  Obtener la lista de servidores de la agrupación
  
  <strong>Memcached::getServerList()</strong> devuelve la lista de todos los servidores de la agrupación de
  servidores.

<comment>Return:</comment>
  <info>array</info>  La lista de todos los servidores de la agrupación de servidores.


id: Memcached::getStats
type: function
doc:
<comment>Description:</comment>
  Obtener las estadísticas de la agrupación de servidores
  
  <strong>Memcached::getStats()</strong> devuelve un array que contiene el estado de todos los servidores de memcache
  disponibles. Ver la especificación del protocolo de memcache para más información sobre estas
  estadísticas.

<comment>Return:</comment>
  <info>array</info>  Array de estadísticas de servidores, una entrada por servidor.


id: Memcached::getVersion
type: function
doc:
<comment>Description:</comment>
  Obtener la información de la versión de la agrupación de servidores
  
  <strong>Memcached::getVersion()</strong> devuelve un array que contine la información de la versión de todos los
  servidores de memcache disponibles.

<comment>Return:</comment>
  <info>array</info>  Array de las versiones de los servidores, una entrada por servidor.


id: Memcached::increment
type: function
doc:
<comment>Description:</comment>
  Incrementar un valor numérico de un ítem
  
  <strong>Memcached::increment()</strong> incrementa un valor numérico de un ítem por el <strong>$offset</strong> especificado. Si el
  valor del ítem no es numérico, generará un error. <strong>Memcached::increment()</strong> establecerá el ítem al
  parámetro <strong>$initial_value</strong> si la clave no existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>            La clave del ítem a incrementar.
  <info>int</info>     <strong>$offset</strong>         La cantidad por la que incrementar el valor del ítem.
  <info>int</info>     <strong>$initial_value</strong>  El valor para establecer el ítem si actualmente no existe.
  <info>int</info>     <strong>$expiry</strong>         El periodo de expiración a establecer para el ítem.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor del ítem en caso de éxito  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::decrementByKey
   * Memcached::incrementByKey


id: Memcached::incrementByKey
type: function
doc:
<comment>Description:</comment>
  Incrementar un valor numérico de un ítem, almacenado en un servidor específico
  
  <strong>Memcached::incrementByKey()</strong> incrementa un valor numérico de un ítem por el <strong>$offset</strong> especificado.
  Si el valor del ítem no es numérico, generará un error. <strong>Memcached::incrementByKey()</strong> establecerá el
  ítem al parámetro <strong>$initial_value</strong> si la clave no existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>     La clave que identifica al servidor donde guardar o recuperar el valor. En
                          lugar de realizar un hash en la clave real para el ítem, se realiza en la
                          clave del servidor cuando se decide con qué servidor de memcached
                          conversar. Esto permite que los ítems relacionados sean agrupados en un
                          único servidor para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>            La clave del ítem a incrementar.
  <info>int</info>     <strong>$offset</strong>         La cantidad por la que incrementar el valor del ítem.
  <info>int</info>     <strong>$initial_value</strong>  El valor para establecer el ítem si actualmente no existe.
  <info>int</info>     <strong>$expiry</strong>         El periodo de expiración a establecer para el ítem.

<comment>Return:</comment>
  <info>int</info>  Devuelve el nuevo valor del ítem en caso de éxito  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::decrementByKey
   * Memcached::increment


id: Memcached::isPersistent
type: function
doc:
<comment>Description:</comment>
  Comprueba si se está utilizando una conexión persistente a memcache
  
  <strong>Memcached::isPersistent()</strong> comprueba si las conexiones a  los servidores de memcache son conexiones
  persistentes.

<comment>Return:</comment>
  <info>bool</info>  Devuelve true si la instancia de Memcache usa una conexión persistente, de lo contrario
        devuelve false.

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


id: Memcached::isPristine
type: function
doc:
<comment>Description:</comment>
  Comprobar si la instancia se creó recientemente
  
  <strong>Memcached::isPristine()</strong> comprueba si la instancia de Memcached  se creó recientemente.

<comment>Return:</comment>
  <info>bool</info>  Devuelve true si la instancia se creó recientemente, de lo contrario devuelve false.

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


id: Memcached::prepend
type: function
doc:
<comment>Description:</comment>
  Anteponer datos a un ítem existente
  
  <strong>Memcached::prepend()</strong> antepone el string dado por <strong>$value</strong> al valor del ítem existente. La razón por
  la que se fuerza a <strong>$value</strong> a ser un string es debido a que no está bien definida la adición de
  tipos mixtos.
  
  Si <info>Memcached::OPT_COMPRESSION</info> está activado, la operación fallará y se emitirá una advertencia, ya
  que no es posible anteponer datos comprimidos a un valor que potencialmente ya está comprimido.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    La clave del ítem en el que anteponer datos.
  <info>string</info>  <strong>$value</strong>  El string a anteponer.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::prependByKey
   * Memcached::append


id: Memcached::prependByKey
type: function
doc:
<comment>Description:</comment>
  Anteponer datos a un ítem existente en un servidor específico
  
  La funcionalidad de <strong>Memcached::prependByKey()</strong> es equivalente a la de Memcached::prepend, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave del ítem en el que anteponer datos.
  <info>string</info>  <strong>$value</strong>       El string a anteponer.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::prepend
   * Memcached::append


id: Memcached::quit
type: function
doc:
<comment>Description:</comment>
  Cierra cualquier conexión abierta
  
  <strong>Memcached::quit()</strong> cierra las conexiones abiertas a los  servidores de memcache.

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


id: Memcached::replace
type: function
doc:
<comment>Description:</comment>
  Reemplaza un ítem asociado a una clave existente
  
  <strong>Memcached::replace()</strong> es similar a  Memcached::set, pero la operación fallará si la clave dada por
  <strong>$key</strong> no existe en el servidor.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::replaceByKey
   * Memcached::set
   * Memcached::add


id: Memcached::replaceByKey
type: function
doc:
<comment>Description:</comment>
  Reemplazar un ítem bajo una clave existente en un servidor específico
  
  La funcionalidad de <strong>Memcached::replaceByKey()</strong> es equivalente a la de Memcached::replace, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico. Es útil si se necesita relacionar cierta cantidad de claves a un servidor
  determinado.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Memcached::getResultCode devolverá
        <info>Memcached::RES_NOTSTORED</info> si la clave no existe.

<comment>See Also:</comment>
   * Memcached::replace
   * Memcached::set
   * Memcached::add


id: Memcached::resetServerList
type: function
doc:
<comment>Description:</comment>
  Limpia todos los servidores de la lista de servidores
  
  <strong>Memcached::resetserverlist()</strong> elimina todos los servidores de memcache  de la lista de servidores
  conocidos, dejándola vacía de nuevo.

<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>
   * Memcached::addServer
   * Memcached::addServers


id: Memcached::set
type: function
doc:
<comment>Description:</comment>
  Guardar un ítem
  
  <strong>Memcached::set()</strong> guarda el valor dado por <strong>$value</strong> en un servidor de memcached bajo la clave
  especificada por <strong>$key</strong>. El parámetro <strong>$expiration</strong> se puede emplear para controlar cuándo se
  considera que ha expirado el valor.
  
  El valor puede ser cualquier tipo de PHP válido excepto recursos, ya que estos no se pueden
  representar de forma serializada. Si la opción <info>Memcached::OPT_COMPRESSION</info> está activada, el valor
  serializado será además comprimido antes de guardarlo.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

<comment>See Also:</comment>
   * Memcached::setByKey
   * Memcached::add
   * Memcached::replace


id: Memcached::setByKey
type: function
doc:
<comment>Description:</comment>
  Guardar un ítem en un servidor específico
  
  La funcionalidad de <strong>Memcached::setByKey()</strong> es equivalente a la de Memcached::set, con la excepción
  de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un servidor
  específico. Es útil si se necesita relacionar cierta cantidad de claves a un servidor determinado.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>mixed</info>   <strong>$value</strong>       El valor a guardar.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

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


id: Memcached::setMulti
type: function
doc:
<comment>Description:</comment>
  Almacenar varios ítems
  
  <strong>Memcached::setMulti()</strong> es similar a Memcached::set, pero en lugar de almacenar un único ítem de
  clave/valor, funciona con múltiples ítems especificados en <strong>$items</strong>. El tiempo de <strong>$expiration</strong> se
  aplica a todos los ítems a la vez.

<comment>Param:</comment>
  <info>array</info>  <strong>$items</strong>       Un array de pares de clave/valor a almacenar en el servidor.
  <info>int</info>    <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para más
                      información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

<comment>See Also:</comment>
   * Memcached::setMultiByKey
   * Memcached::set


id: Memcached::setMultiByKey
type: function
doc:
<comment>Description:</comment>
  Almacena varios ítems en un servidor específico
  
  La funcionalidad de <strong>Memcached::setMultiByKey()</strong> es equivalente a la de Memcached::setMulti, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico. Es útil si se necesita relacionar cierta cantidad de claves a un servidor
  determinado.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>array</info>   <strong>$items</strong>       Un array de pares de clave/valor a almacenar en el servidor.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

<comment>See Also:</comment>
   * Memcached::setMulti
   * Memcached::set


id: Memcached::setOption
type: function
doc:
<comment>Description:</comment>
  Establecer una opción de Memcached
  
  Este método establece el valor de una opción de Memcached dada por <strong>$option</strong>. Algunas opciones
  corresponden a las definidas por libmemcached y otras son específicas a la extensión. Vea las
  Constantes de Memcached para más información.
  
  Las opciones enumeradas más abajo requieren valores especificados mediante constantes.
  <info>Memcached::OPT_HASH</info> require valores <info>Memcached::HASH_*</info>. <info>Memcached::OPT_DISTRIBUTION</info> requiere
  valores <info>Memcached::DISTRIBUTION_*</info>.
  
  <info>Memcached::OPT_HASH</info> require valores <info>Memcached::HASH_*</info>.
  
  <info>Memcached::OPT_DISTRIBUTION</info> requiere valores <info>Memcached::DISTRIBUTION_*</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>
   * Memcached::getOption
   * Memcached::setOptions
   * Constantes de Memcached


id: Memcached::setOptions
type: function
doc:
<comment>Description:</comment>
  Establecer opciones de Memcached
  
  <strong>Memcached::setOptions()</strong> es una variación de  Memcached::setOption que toma un array de  opciones a
  establecer.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Un array asociativo de opciones donde la clave es la opción a establecer y  el
                   valor es el nuevo valor para dicha opción.

<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>
   * Memcached::getOption
   * Memcached::setOption
   * Constantes de Memcached


id: Memcached::setSaslAuthData
type: function
doc:
<comment>Description:</comment>
  Establecer las credenciales para la autenticación
  
  <strong>Memcached::setSaslAuthData()</strong> establece el nombre de usuario y la contraseña que deberían
  utilizarse para la autenticación SASL con los servidores de memcache.
  
  Este método solamente está disponible cuando la extensión memcached está construida con soporte
  para SASL. Consulte la Configuración de memcached para saber cómo se hace esto.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  El nombre de usuario para la autenticación.
  <info>string</info>  <strong>$password</strong>  La contraseña para la autenticación.

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


id: Memcached::touch
type: function
doc:
<comment>Description:</comment>
  Establecer una nueva expiración para un ítem
  
  <strong>Memcached::touch()</strong> establece un nuevo valor de expiración para la clave dada.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

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


id: Memcached::touchByKey
type: function
doc:
<comment>Description:</comment>
  Establecer una nueva expiración para un ítem de un servidor específico
  
  La funcionalidad de <strong>Memcached::touchByKey()</strong> es equivalente a la de Memcached::touch, con la
  excepción de que <strong>$server_key</strong> se puede utilizar para que la clave dada por <strong>$key</strong> corresponda a un
  servidor específico.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  La clave que identifica al servidor donde guardar o recuperar el valor. En
                       lugar de realizar un hash en la clave real para el ítem, se realiza en la
                       clave del servidor cuando se decide con qué servidor de memcached conversar.
                       Esto permite que los ítems relacionados sean agrupados en un único servidor
                       para una mayor eficacia con operaciones múltiples.
  <info>string</info>  <strong>$key</strong>         La clave en la que se guardará el valor.
  <info>int</info>     <strong>$expiration</strong>  Tiempo de expiración, que por defecto es 0. Ver Tiempos de expiración para
                       más información.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Emplee Memcached::getResultCode si
        fuera necesario.

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


id: MessageFormatter
type: class
doc:
<comment>Description:</comment>
  MessageFormatter es una clase concreta que permite a los usuarios producir mensajes concatenados
  neutrales al lenguaje. Los métodos proporcionados por esta clase se utilizan para construir todos
  los mensajes que son vistos por usuarios finales.
  
  La clase MessageFormatter ensambla mensajes desde varios fragmentos (tales como framentos de
  texto, números y fechas) proporcionados por el programa. Gracias a la clase MessageFormatter, el
  programa no necesita conocer el orden de los fragmentos. La clase utiliza las especificaciones de
  formateo de los fragmentos para ensamblarlos en un mensaje que está contenido en una única cadena
  dentro de un paquete de recursos. Por ejemplo, MessageFormatter permite imprimir la frase
  "Finalizada la impresión de x de y ficheros..." de una manera que aún admite flexibilidad para
  traducciones.
  
  Anteriormente, un mensaje de un usuario final era creado como una sentencia y tratado como una
  cadna. Este procedimiento creaba problemas para los regionalizadores ya que la estructura de la
  sentencia, el orden de las palabras, el formato de número, etc., son muy diferentes de un lenguaje
  a otro. La manera neutral de lenguaje para crear mensajes mantiene cada parte del mensaje separada
  y proporciona claves a la información. Al utilizar estas claves, la clase MessageFormatter puede
  concatenar las partes del mensaja, regionalizarlas, y mostrar al usuario final una cadena bien
  formada.
  
  MessageFormatter toma un conjunto de objetos, les da formato e inserta las cadenas formateadas en
  un patrón en los lugares apropiados. Los formatos escogidos se pueden usar en conjunto con
  MessageFormatter para tratar prurales, comparar números, y seleccionarlos desde un array de
  elementos. Normalmente, el formato del mensaje se obtendrá desde recursos, y los argumentos se
  establecerán dinámicamente en tiempo de ejecución.


id: MessageFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un nuevo Formateador de Mensajes
  
  Estilo orientado a objetos (método)
  
  Estilo orientado a objetos (constructor):
  
  Estilo por procedimientos
  
  Construye un nuevo Formateador de Mensajes

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   La configuración regional a usar al formatear los argumentos
  <info>string</info>  <strong>$pattern</strong>  La cadena patrón con la que pegar los argumentos.  El patrón utiliza una
                    sintaxis 'amigable con apóstrofes'; se ejecuta a través de
                    umsg_autoQuoteApostrophe antes de ser interpretado.

<comment>Return:</comment>
  <info>MessageFormatter</info>  Un <info>object</info> formateador

<comment>See Also:</comment>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::format
type: function
doc:
<comment>Description:</comment>
  Dar formato al mensaje
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Da formato al mensaje mediante la sustitución de los datos en la cadena de formato  de acuerdo con
  las normas de configuración regional

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>   El formateador de mensajes
  <info>array</info>             <strong>$args</strong>  Los argumentos para insertar en la cadena de formato

<comment>Return:</comment>
  <info>string</info>  La cadena de formato, o <info>false</info> si ocurre un error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::formatMessage
type: function
doc:
<comment>Description:</comment>
  Formateo rápido de un mensaje
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Función de formateo rápido que da formato al string sin tener que crear explícitamente el objeto
  formateador. Utilice esta función cuando la operación de formateo se realice únicamente una vez y
  no necesite parámetros o estados para que se mantenga.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   La configuración regional a usar para el formateo de partes dependientes de la
                    región
  <info>string</info>  <strong>$pattern</strong>  El patrón de tipo <info>string</info> por el que insertar los elementos. El patrón utiliza
                    una sintaxis 'amigable con apóstrofes'; se ejecuta a través de
                    umsg_autoQuoteApostrophe antes de ser interpretado.
  <info>array</info>   <strong>$args</strong>     El <info>array</info> de valores a insertar en el <info>string</info> de formato

<comment>Return:</comment>
  <info>string</info>  El patrón de tipo string formateado, o <info>false</info> en caso de error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el código de error de la última operación
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el código de error de la última operación.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  El formateador de mensajes

<comment>Return:</comment>
  <info>int</info>  El código de error, uno del os valores UErrorCode. El valor inicial es U_ZERO_ERROR.

<comment>See Also:</comment>
   * <strong>msgfmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: MessageFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el texto del error de la última operación
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener el texto del error de la última operación.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  El formateador de mensajes

<comment>Return:</comment>
  <info>string</info>  La descripción del último error.

<comment>See Also:</comment>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: MessageFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Obtener la configuración regional desde la que se creó el formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene la configuración regional desde la que se creó el formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  El recurso del formateador

<comment>Return:</comment>
  <info>string</info>  El nombre de la configuración regional

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


id: MessageFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Obtener el patrón usado por el formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el patrón usado por el formateador

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  El formateador de mensajes

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> del patrón para este formateador

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_set_pattern()</strong>


id: MessageFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Procesar la cadena de entrada según un patrón
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Procesa el <info>string</info> de entrada y devuelve cualquier elemento extraído en un <info>array</info>.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>    El formateador de mensajes
  <info>string</info>            <strong>$value</strong>  El <info>string</info> a procesar

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contiene los elementos extraídos, o <info>false</info> en caso de error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse_message()</strong>


id: MessageFormatter::parseMessage
type: function
doc:
<comment>Description:</comment>
  Procesar rápidamente una cadena de entrada
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Procesa una cadena de entrada sin crear explícitamente el objeto formateador. Utilice esta función
  cuando la operación de formateo se realice sólo una vez y no necesite parámetros o estados para
  que se mantenga.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   La configuración regional a usar para el procesamiento de las partes
                    dependientes de la región
  <info>string</info>  <strong>$pattern</strong>  El patrón con el que procesar <strong>$value</strong>.
  <info>string</info>  <strong>$source</strong>   El <info>string</info> a procesar, de acuerdo al patrón dado por <strong>$pattern</strong>.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contiene los elementos extraídos, o <info>false</info> en caseo de error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_parse()</strong>


id: MessageFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Establecer el patrón usado por el formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el patrón usado por el formateador

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>      El formateador de mensajes
  <info>string</info>            <strong>$pattern</strong>  El patrón de tipo <info>string</info> para utilizarlo en el formateador de
                              mensajes. El patrón utiliza una sintaxis 'amigable con apóstrofes'; se
                              ejecuta a través de umsg_autoQuoteApostrophe  antes de ser
                              interpretado.

<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>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_get_pattern()</strong>


id: MongoDB\BSON\Binary::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Binary

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Binary data.
  <info>int</info>     <strong>$type</strong>  Unsigned 8-bit integer denoting the data's type. Defaults to
                 <info>MongoDB\BSON\Binary::TYPE_GENERIC</info> if not specified.

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


id: MongoDB\BSON\Binary::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the Binary's data
  
  Este método es un alias de:  MongoDB\BSON\Binary::getData.

<comment>Return:</comment>
  <info>string</info>  Returns the Binary's data.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getData
   * BSON Types


id: MongoDB\BSON\Binary::getData
type: function
doc:
<comment>Description:</comment>
  Returns the Binary's data

<comment>Return:</comment>
  <info>string</info>  Returns the Binary's data.

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


id: MongoDB\BSON\Binary::getType
type: function
doc:
<comment>Description:</comment>
  Returns the Binary's type

<comment>Return:</comment>
  <info>int</info>  Returns the Binary's type.

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


id: MongoDB\BSON\Binary::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Binary</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Binary::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Binary

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Binary</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Binary::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Binary

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Binary</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\BinaryInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\Binary</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\BinaryInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the BinaryInterface's data
  
  Este método es un alias de:  MongoDB\BSON\BinaryInterface::getData.

<comment>Return:</comment>
  <info>string</info>  Returns the BinaryInterface's data.

<comment>See Also:</comment>
   * MongoDB\BSON\BinaryInterface::getData
   * MongoDB\BSON\Binary::__toString


id: MongoDB\BSON\BinaryInterface::getData
type: function
doc:
<comment>Description:</comment>
  Returns the BinaryInterface's data

<comment>Return:</comment>
  <info>string</info>  Returns the BinaryInterface's data.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getData


id: MongoDB\BSON\BinaryInterface::getType
type: function
doc:
<comment>Description:</comment>
  Returns the BinaryInterface's type

<comment>Return:</comment>
  <info>int</info>  Returns the BinaryInterface's type.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getType


id: MongoDB\BSON\DBPointer
type: class
doc:
<comment>Description:</comment>
  BSON type for the "DBPointer" type. This BSON type is deprecated, and this class can not be
  instantiated. It will be created from a BSON DBPointer type while converting BSON to PHP, and can
  also be converted back into BSON while storing documents in the database.


id: MongoDB\BSON\DBPointer::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new DBPointer (unused)
  
  <class>MongoDB\BSON\DBPointer</class> objects are created through conversion from a deprecated BSON type and
  cannot be constructed directly.

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


id: MongoDB\BSON\DBPointer::__toString
type: function
doc:
<comment>Description:</comment>
  Returns an empty string

<comment>Return:</comment>
  <info>string</info>  Returns an empty string.

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


id: MongoDB\BSON\DBPointer::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\DBPointer</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\DBPointer::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a DBPointer

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\DBPointer</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\DBPointer::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\DBPointer::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a DBPointer

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\DBPointer</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\DBPointer::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Decimal128
type: class
doc:
<comment>Description:</comment>
  BSON type for the Decimal128 floating-point format, which supports numbers with up to 34 decimal
  digits (i.e. significant digits) and an exponent range of −6143 to +6144.
  
  Unlike the double BSON type (i.e. <info>float</info> in PHP), which only stores an approximation of the decimal
  values, the decimal data type stores the exact value. For example, <return>MongoDB\BSON\Decimal128('9.99')</return>
  has a precise value of 9.99 where as a double 9.99 would have an approximate value of
  9.9900000000000002131628….
  
  <class>MongoDB\BSON\Decimal128</class> solamente es compatible con MongoDB 3.4+. Intentar usar el tipo BSON con
  una versión anterior de MongoDB resultará en un error.


id: MongoDB\BSON\Decimal128::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Decimal128
  
  <class>MongoDB\BSON\Decimal128</class> solamente es compatible con MongoDB 3.4+. Intentar usar el tipo BSON con
  una versión anterior de MongoDB resultará en un error.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  A decimal string.

<comment>See Also:</comment>
   * Decimal128 floating-point format
   * BSON Types


id: MongoDB\BSON\Decimal128::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this Decimal128

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Decimal128.

<comment>See Also:</comment>
   * Decimal128 floating-point format
   * BSON Types


id: MongoDB\BSON\Decimal128::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Decimal128</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Decimal128::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Decimal128

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Decimal128</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Decimal128::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Decimal128::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Decimal128

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Decimal128</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Decimal128::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Decimal128Interface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\Decimal128</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\Decimal128Interface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this Decimal128Interface

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Decimal128Interface.

<comment>See Also:</comment>
   * MongoDB\BSON\Decimal128::__toString


id: MongoDB\BSON\Int64
type: class
doc:
<comment>Description:</comment>
  BSON type for a 64-bit integer. When decoding BSON to PHP data, this class is used when a 64-bit
  integer cannot be represented as a PHP integer on 32-bit platforms. These objects support
  overloaded arithmetic, bitwise, and comparison operators.
  
  When working with raw BSON data through the <class>MongoDB\BSON\Document</class>, <class>MongoDB\BSON\PackedArray</class>, and
  <class>MongoDB\BSON\Iterator</class> classes, any 64-bit integer will be returned as an instance of this class,
  regardless of platform and whether the value can be represented as a PHP integer. This ensures
  that values can be roundtripped without changing the type.
  
  During BSON encoding, objects of this class will convert back to a 64-bit integer type, even when
  the value would fit in a 32-bit integer. This allows explicitly storing values as 64-bit integers
  in BSON.


id: MongoDB\BSON\Int64::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Int64
  
  Creates a new <class>MongoDB\BSON\Int64</class> instance for the given integer value.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  The value to assign to the <class>Int64</class> instance. This value can be provided as an
                      <info>int</info> or <info>string</info>, the latter being required on 32-bit platforms to represent
                      64-bit values.

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


id: MongoDB\BSON\Int64::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this Int64

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Int64.

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


id: MongoDB\BSON\Int64::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Int64</class>.
         
         The output is consistent with the <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> function, which
         uses the canonical extended JSON format. This differs from other BSON classes, which use
         the driver-specific legacy extended JSON format (<strong>MongoDB\BSON\toJSON()</strong>), in order to ensure
         that the 64-bit integer value is correctly represented on 32-bit platforms.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Int64::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize an Int64

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Int64</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Int64::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Int64::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize an Int64

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Int64</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Int64::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Javascript::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Javascript

<comment>Param:</comment>
  <info>string</info>             <strong>$code</strong>   Javascript code.
  <info>array|object|null</info>  <strong>$scope</strong>  Javascript scope.

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


id: MongoDB\BSON\Javascript::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the Javascript's code
  
  Este método es un alias de:  MongoDB\BSON\Javascript::getCode.

<comment>Return:</comment>
  <info>string</info>  Returns the Javascript's code.

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getCode
   * BSON Types


id: MongoDB\BSON\Javascript::getCode
type: function
doc:
<comment>Description:</comment>
  Returns the Javascript's code

<comment>Return:</comment>
  <info>string</info>  Returns the Javascript's code.

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


id: MongoDB\BSON\Javascript::getScope
type: function
doc:
<comment>Description:</comment>
  Returns the Javascript's scope document

<comment>Return:</comment>
  <info>object|null</info>  Returns the Javascript's scope document, or <info>null</info> if the is no scope.

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


id: MongoDB\BSON\Javascript::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Javascript</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Javascript::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Javascript

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Javascript</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Javascript::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Javascript

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Javascript</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\JavascriptInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\Javascript</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\JavascriptInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the JavascriptInterface's code
  
  Este método es un alias de:  MongoDB\BSON\JavascriptInterface::getCode.

<comment>Return:</comment>
  <info>string</info>  Returns the JavascriptInterface's code.

<comment>See Also:</comment>
   * MongoDB\BSON\JavascriptInterface::getCode
   * MongoDB\BSON\Javascript::__toString


id: MongoDB\BSON\JavascriptInterface::getCode
type: function
doc:
<comment>Description:</comment>
  Returns the JavascriptInterface's code

<comment>Return:</comment>
  <info>string</info>  Returns the JavascriptInterface's code.

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getCode


id: MongoDB\BSON\JavascriptInterface::getScope
type: function
doc:
<comment>Description:</comment>
  Returns the JavascriptInterface's scope document

<comment>Return:</comment>
  <info>object|null</info>  Returns the JavascriptInterface's scope document.

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getScope


id: MongoDB\BSON\MaxKey::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new MaxKey

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


id: MongoDB\BSON\MaxKey::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\MaxKey</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\MaxKey::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a MaxKey

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\MaxKey</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\MaxKey::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\MaxKey::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a MaxKey

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\MaxKey</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\MaxKey::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\MaxKeyInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\MaxKey</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\MinKey::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new MinKey

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


id: MongoDB\BSON\MinKey::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\MinKey</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\MinKey::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a MinKey

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\MinKey</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\MinKey::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\MinKey::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a MinKey

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\MinKey</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\MinKey::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\MinKeyInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\MinKey</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\ObjectId::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ObjectId

<comment>Param:</comment>
  <info>string|null</info>  <strong>$id</strong>  A 24-character hexadecimal string. If not provided, the driver will generate an
                    ObjectId.

<comment>See Also:</comment>
   * ObjectId Reference
   * BSON Types: ObjectId


id: MongoDB\BSON\ObjectId::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the hexidecimal representation of this ObjectId

<comment>Return:</comment>
  <info>string</info>  Returns the hexidecimal representation of this ObjectId.

<comment>See Also:</comment>
   * ObjectId Reference
   * BSON Types: ObjectId


id: MongoDB\BSON\ObjectId::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Returns the timestamp component of this ObjectId
  
  The timestamp component of an ObjectId is its most significant 32 bits, which denotes the number
  of seconds since the Unix epoch. This value is read as an unsigned 32-bit integer with big-endian
  byte order.
  
  Debido a que le tipo de entero de PHP es con signo, algunos valores devueltos por este método
  podrían aparecer como enteros negativos en plataformas de 32 bits. El formateador <return>"%u"</return> de
  <strong>sprintf()</strong> se puede usar para obtener una representación de string del valor decimal sin signo.

<comment>Return:</comment>
  <info>int</info>  Returns the timestamp component of this ObjectId.

<comment>See Also:</comment>
   * ObjectId Reference
   * BSON Types: ObjectId


id: MongoDB\BSON\ObjectId::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\ObjectId</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\ObjectId::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize an ObjectId

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\ObjectId</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\ObjectId::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize an ObjectId

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\ObjectId</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\ObjectIdInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\ObjectId</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\ObjectIdInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the hexidecimal representation of this ObjectIdInterface

<comment>Return:</comment>
  <info>string</info>  Returns the hexidecimal representation of this ObjectIdInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::__toString


id: MongoDB\BSON\ObjectIdInterface::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Returns the timestamp component of this ObjectIdInterface

<comment>Return:</comment>
  <info>int</info>  Returns the timestamp component of this ObjectIdInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::getTimestamp


id: MongoDB\BSON\Persistable
type: class
doc:
<comment>Description:</comment>
  Las clases podrían implementar esta interfaz para tomar ventaja de comportamiento del ODM («object
  document mapping») automático del controlador. Durante la serialización, el controlador inyectará
  una propiedad __pclass que contiene el nombre de la clase de PHP dentro de los datos devueltos por
  <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>. Durante la deserialización, se utilizará la misma
  propiedad __pclass      para inferir la clase de PHP (ndependientemente de cualquier configuración
  type map) a construir antes de que <strong>MongoDB\BSON\Unserializable::bsonUnserialize()</strong> sea invocado.
  Véase  para información adicional.
  
  Incluso si <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong> devuelve un array secuencial, las
  inyecciones de la propiedad __pclass causarán que el objeto sea serializado como un documento
  BSON.


id: MongoDB\BSON\Regex::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Regex

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The regular expression pattern.
                    
                    The pattern should not be wrapped with delimiter characters.
  <info>string</info>  <strong>$flags</strong>    The regular expression flags. Characters in this argument will be sorted
                    alphabetically.

<comment>See Also:</comment>
   * BSON Types
   * Supported regular expression flags


id: MongoDB\BSON\Regex::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this Regex

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Regex.

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


id: MongoDB\BSON\Regex::getFlags
type: function
doc:
<comment>Description:</comment>
  Returns the Regex's flags

<comment>Return:</comment>
  <info>string</info>  Returns the Regex's flags.

<comment>See Also:</comment>
   * BSON Types
   * Supported regular expression flags


id: MongoDB\BSON\Regex::getPattern
type: function
doc:
<comment>Description:</comment>
  Returns the Regex's pattern

<comment>Return:</comment>
  <info>string</info>  Returns the Regex's pattern.

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


id: MongoDB\BSON\Regex::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Regex</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Regex::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Regex

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Regex</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Regex::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Regex

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Regex</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\RegexInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\Regex</class> to be used as a parameter, return, or property
  type in userland classes.


id: MongoDB\BSON\RegexInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this RegexInterface

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this RegexInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::__toString


id: MongoDB\BSON\RegexInterface::getFlags
type: function
doc:
<comment>Description:</comment>
  Returns the RegexInterface's flags

<comment>Return:</comment>
  <info>string</info>  Returns the RegexInterface's flags.

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::getFlags


id: MongoDB\BSON\RegexInterface::getPattern
type: function
doc:
<comment>Description:</comment>
  Returns the RegexInterface's pattern

<comment>Return:</comment>
  <info>string</info>  Returns the RegexInterface's pattern.

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::getPattern


id: MongoDB\BSON\Serializable
type: class
doc:
<comment>Description:</comment>
  Las clases que implementan esta interfaz podrían devolver datos para ser serializados como un
  array o documento BSON en lugar de las propiedades públicas del objeto.


id: MongoDB\BSON\Serializable::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Provides an array or document to serialize as BSON
  
  Called during serialization of the object to BSON. The method must return an <info>array</info>, <class>stdClass</class>,
  <class>MongoDB\BSON\Document</class>, or <class>MongoDB\BSON\PackedArray</class>.
  
  Root documents (e.g. a MongoDB\BSON\Serializable passed to <strong>MongoDB\BSON\fromPHP()</strong>) will always be
  serialized as a BSON document. For field values, associative arrays and <class>stdClass</class> instances will be
  serialized as a BSON document and sequential arrays (i.e. sequential, numeric indexes starting at
  <return>0</return>) will be serialized as a BSON array.
  
  Users are encouraged to include an _id property (e.g. a <class>MongoDB\BSON\ObjectId</class> initialized in your
  constructor) when returning data for a BSON root document; otherwise, the driver or database will
  need to generate a <class>MongoDB\BSON\ObjectId</class> when inserting or upserting the document, respectively.

<comment>Return:</comment>
  <info>array|stdClass|MongoDB\BSON\Document|MongoDB\BSON\PackedArray</info>  An <info>array</info>, <class>stdClass</class>,
                                                                 <class>MongoDB\BSON\Document</class>, or
                                                                 <class>MongoDB\BSON\PackedArray</class> to be
                                                                 serialized as a BSON array or
                                                                 document.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Unserializable::bsonUnserialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\Symbol
type: class
doc:
<comment>Description:</comment>
  BSON type for the "Symbol" type. This BSON type is deprecated, and this class can not be
  instantiated. It will be created from a BSON symbol type while converting BSON to PHP, and can
  also be converted back into BSON while storing documents in the database.


id: MongoDB\BSON\Symbol::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Symbol (unused)
  
  <class>MongoDB\BSON\Symbol</class> objects are created through conversion from a deprecated BSON type and cannot
  be constructed directly.

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


id: MongoDB\BSON\Symbol::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the Symbol as a string

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Symbol.

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


id: MongoDB\BSON\Symbol::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Symbol</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Symbol::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Symbol

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Symbol</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Symbol::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Symbol::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Symbol

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Symbol</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Symbol::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Timestamp
type: class
doc:
<comment>Description:</comment>
  Represents a BSON timestamp, The value consists of a 4-byte timestamp (i.e. seconds since the
  epoch) and a 4-byte increment.
  
  This is an internal MongoDB type used for replication and sharding. It is not intended for general
  date storage (<class>MongoDB\BSON\UTCDateTime</class> should be used instead).


id: MongoDB\BSON\Timestamp::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Timestamp

<comment>Param:</comment>
  <info>int</info>  <strong>$increment</strong>  32-bit integer denoting the incrementing ordinal for operations within a given
                   second.
  <info>int</info>  <strong>$timestamp</strong>  32-bit integer denoting seconds since the Unix epoch.

<comment>See Also:</comment>
   * BSON Types: Timestamps


id: MongoDB\BSON\Timestamp::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this Timestamp

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this Timestamp.

<comment>See Also:</comment>
   * BSON Types: Timestamps


id: MongoDB\BSON\Timestamp::getIncrement
type: function
doc:
<comment>Description:</comment>
  Returns the increment component of this Timestamp
  
  The increment component of a Timestamp is its least significant 32 bits, whichs denotes the
  incrementing ordinal for operations within a given second. This value is read as an unsigned
  32-bit integer with big-endian byte order.
  
  Debido a que le tipo de entero de PHP es con signo, algunos valores devueltos por este método
  podrían aparecer como enteros negativos en plataformas de 32 bits. El formateador <return>"%u"</return> de
  <strong>sprintf()</strong> se puede usar para obtener una representación de string del valor decimal sin signo.

<comment>Return:</comment>
  <info>int</info>  Returns the increment component of this Timestamp.
       
       On 32-bit systems this method may return a negative number. Although the increment and
       timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can
       not represent these on 32-bit platforms.

<comment>See Also:</comment>
   * BSON Types: Timestamps


id: MongoDB\BSON\Timestamp::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Returns the timestamp component of this Timestamp
  
  The timestamp component of a Timestamp is its most significant 32 bits, which denotes the number
  of seconds since the Unix epoch. This value is read as an unsigned 32-bit integer with big-endian
  byte order.
  
  Debido a que le tipo de entero de PHP es con signo, algunos valores devueltos por este método
  podrían aparecer como enteros negativos en plataformas de 32 bits. El formateador <return>"%u"</return> de
  <strong>sprintf()</strong> se puede usar para obtener una representación de string del valor decimal sin signo.

<comment>Return:</comment>
  <info>int</info>  Returns the timestamp component of this Timestamp.
       
       On 32-bit systems this method may return a negative number. Although the increment and
       timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can
       not represent these on 32-bit platforms.

<comment>See Also:</comment>
   * BSON Types: Timestamps


id: MongoDB\BSON\Timestamp::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Timestamp</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Timestamp::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Timestamp

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Timestamp</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Timestamp::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Timestamp

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Timestamp</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\TimestampInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\Timestamp</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\TimestampInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this TimestampInterface

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this TimestampInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::__toString


id: MongoDB\BSON\TimestampInterface::getIncrement
type: function
doc:
<comment>Description:</comment>
  Returns the increment component of this TimestampInterface

<comment>Return:</comment>
  <info>int</info>  Returns the increment component of this TimestampInterface.
       
       On 32-bit systems this method may return a negative number. Although the increment and
       timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can
       not represent these on 32-bit platforms.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::getIncrement


id: MongoDB\BSON\TimestampInterface::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Returns the timestamp component of this TimestampInterface

<comment>Return:</comment>
  <info>int</info>  Returns the timestamp component of this TimestampInterface.
       
       On 32-bit systems this method may return a negative number. Although the increment and
       timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can
       not represent these on 32-bit platforms.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::getTimestamp


id: MongoDB\BSON\UTCDateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new UTCDateTime

<comment>Param:</comment>
  <info>int|float|string|DateTimeInterface|null</info>  <strong>$milliseconds</strong>  Number of milliseconds since the Unix
                                                          epoch (Jan 1, 1970). Negative values
                                                          represent dates before 1970. This value
                                                          may be provided as a 64-bit <info>int</info>. For
                                                          compatibility on 32-bit systems, this
                                                          parameter may also be provided as a <info>float</info>
                                                          or <info>string</info>.
                                                          
                                                          If the argument is a <class>DateTimeInterface</class>,
                                                          the number of milliseconds since the Unix
                                                          epoch will be derived from that value.
                                                          
                                                          If this argument is <info>null</info>, the current time
                                                          will be used by default.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this UTCDateTime

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this UTCDateTime.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\UTCDateTime</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\UTCDateTime::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a UTCDateTime

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\UTCDateTime</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\UTCDateTime::toDateTime
type: function
doc:
<comment>Description:</comment>
  Returns the DateTime representation of this UTCDateTime

<comment>Return:</comment>
  <info>DateTime</info>  Returns the <class>DateTime</class> representation of this UTCDateTime. The returned <class>DateTime</class> will use
            the UTC time zone.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a UTCDateTime

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\UTCDateTime</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\UTCDateTimeInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\BSON\UTCDateTime</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\BSON\UTCDateTimeInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this UTCDateTimeInterface

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this UTCDateTimeInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::__toString


id: MongoDB\BSON\UTCDateTimeInterface::toDateTime
type: function
doc:
<comment>Description:</comment>
  Returns the DateTime representation of this UTCDateTimeInterface

<comment>Return:</comment>
  <info>DateTime</info>  Returns the <class>DateTime</class> representation of this UTCDateTimeInterface. The returned <class>DateTime</class>
            should use the UTC time zone.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::toDateTime


id: MongoDB\BSON\Undefined
type: class
doc:
<comment>Description:</comment>
  BSON type for the "Undefined" type. This BSON type is deprecated, and this class can not be
  instantiated. It will be created from a BSON undefined type while converting BSON to PHP, and can
  also be converted back into BSON while storing documents in the database.


id: MongoDB\BSON\Undefined::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Undefined (unused)
  
  <class>MongoDB\BSON\Undefined</class> objects are created through conversion from a deprecated BSON type and
  cannot be constructed directly.

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


id: MongoDB\BSON\Undefined::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Undefined</class>.
         
         La salida es consitente con la función <strong>MongoDB\BSON\toJSON()</strong>, la cual usa el formato JSON
         extendido antiguo específico del controlador. Esto no necesariamente coincide con las
         represntaciones extendidas JSON relajada o canónica usadas por
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> y <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Undefined::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Undefined

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\BSON\Undefined</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Undefined::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Undefined::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Undefined

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\BSON\Undefined</class>.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Undefined::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\BSON\Unserializable
type: class
doc:
<comment>Description:</comment>
  Las clases que implementen esta interfaz podrían ser especificadas en un mapa de tipos para arrays
  y documentos de BSON (ambos raíz y embebidos).


id: MongoDB\BSON\Unserializable::bsonUnserialize
type: function
doc:
<comment>Description:</comment>
  Constructs the object from a BSON array or document
  
  Called during unserialization of the object from BSON. The properties of the BSON array or
  document will be passed to the method as an <info>array</info>.
  
  Remember to check for an _id property when handling data from a BSON document.
  
  This method acts as the constructor of the object. The __construct() method will not be called
  after this method.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Properties within the BSON array or document.

<comment>Return:</comment>
  <info>void</info>  The return value from this method is ignored.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\fromJSON
type: function
doc:
<comment>Description:</comment>
  Returns the BSON representation of a JSON value
  
  Converts an extended JSON string to its BSON representation.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>  JSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The serialized BSON document as a binary string.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * <strong>MongoDB\BSON\toJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\fromPHP
type: function
doc:
<comment>Description:</comment>
  Returns the BSON representation of a PHP value
  
  Serializes a PHP array or object (e.g. document) to its BSON representation. The returned binary
  string will describe a BSON document.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$value</strong>  PHP value to be serialized.

<comment>Return:</comment>
  <info>string</info>  The serialized BSON document as a binary string.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * <strong>MongoDB\BSON\toPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toCanonicalExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Canonical Extended JSON representation of a BSON value
  
  Converts a BSON string to its Canonical Extended JSON representation. The canonical format prefers
  type fidelity at the expense of concise output and is most suited for producing output that can be
  converted back to BSON without any loss of type information (e.g. numeric types will remain
  differentiated).

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toCanonicalExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * Extended JSON Specification
   * MongoDB BSON


id: MongoDB\BSON\toJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Legacy Extended JSON representation of a BSON value
  
  Converts a BSON string to its Legacy Extended JSON representation.
  
  There exist several JSON formats for representing BSON. This function implements the "strict mode"
  defined in MongoDB Extended JSON, which has been superseded by the canonical and relaxed formats
  defined in the Extended JSON Specification and implemented by
  <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> and <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>, respectively.
  
  JSON does not support <info>NAN</info> and <info>INF</info> and MongoDB's Legacy Extended JSON format does not define an
  alternative representation for these values (libbson will output <return>nan</return> and <return>inf</return> literals, which may
  not be parsed as valid JSON). If you are working with BSON that may contain non-finite numbers,
  please use <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> or <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\toPHP
type: function
doc:
<comment>Description:</comment>
  Returns the PHP representation of a BSON value
  
  Unserializes a BSON document (i.e. binary string) to its PHP representation. The <strong>$typeMap</strong>
  paramater may be used to control the PHP types used for converting BSON arrays and documents (both
  root and embedded).
  
  BSON documents can technically contain duplicate keys because documents are stored as a list of
  key-value pairs; however, applications should refrain from generating documents with duplicate
  keys as server and driver behavior may be undefined. Since PHP objects and arrays cannot have
  duplicate keys, data could also be lost when decoding a BSON document with duplicate keys.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>     BSON value to be unserialized.
  <info>array</info>   <strong>$typeMap</strong>  Configuración del mapa de tipos.

<comment>Return:</comment>
  <info>array|object</info>  The unserialized PHP value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::toPHP
   * <strong>MongoDB\BSON\fromPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toRelaxedExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Relaxed Extended JSON representation of a BSON value
  
  Converts a BSON string to its Relaxed Extended JSON representation. The relaxed format prefers use
  of JSON type primitives at the expense of type fidelity and is most suited for producing output
  that can be easily consumed by web APIs and humans.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toRelaxedExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * Extended JSON 
   * MongoDB BSON


id: MongoDB\Driver\BulkWrite
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\BulkWrite</class> collects one or more write operations that should be sent to the
  server. After adding any number of insert, update, and delete operations, the collection may be
  executed via MongoDB\Driver\Manager::executeBulkWrite.
  
  Write operations may either be ordered (default) or unordered. Ordered write operations are sent
  to the server, in the order provided, for serial execution. If a write fails, any remaining
  operations will be aborted. Unordered operations are sent to the server in an arbitrary order
  where they may be executed in parallel. Any errors that occur are reported after all operations
  have been attempted.


id: MongoDB\Driver\BulkWrite::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new BulkWrite
  
  Constructs a new <class>MongoDB\Driver\BulkWrite</class>, which is a mutable object to which one or more write
  operations may be added. The write(s) may then be executed with
  MongoDB\Driver\Manager::executeBulkWrite.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  optionsOptionTypeDescriptionDefaultbypassDocumentValidation<info>bool</info> If <info>true</info>,
                        allows insert and update operations to circumvent document level validation.
                        This option is available in MongoDB 3.2+ and is ignored for older server
                        versions, which do not support document level validation. <info>false</info>comment<info>mixed</info>
                        An arbitrary comment to help trace the operation through the database
                        profiler, currentOp output, and logs.  This option is available in MongoDB
                        4.4+ and will result in an exception at execution time if specified for an
                        older server version. let<info>array</info><info>object</info></info> Map of parameter names and values.
                        Values must be constant or closed expressions that do not reference document
                        fields. Parameters can then be accessed as variables in an aggregate
                        expression context (e.g. <return>$$var</return>).  This option is available in MongoDB 5.0+
                        and will result in an exception at execution time if specified for an older
                        server version. ordered<info>bool</info> Ordered operations (<info>true</info>) are executed serially
                        on the MongoDB server, while unordered operations (<info>false</info>) are sent to the
                        server in an arbitrary order and may be executed in parallel. <info>true</info>
                        
                        If <info>true</info>, allows insert and update operations to circumvent document level
                        validation.
                        
                        This option is available in MongoDB 3.2+ and is ignored for older server
                        versions, which do not support document level validation.
                        
                        An arbitrary comment to help trace the operation through the database
                        profiler, currentOp output, and logs.
                        
                        This option is available in MongoDB 4.4+ and will result in an exception at
                        execution time if specified for an older server version.
                        
                        Map of parameter names and values. Values must be constant or closed
                        expressions that do not reference document fields. Parameters can then be
                        accessed as variables in an aggregate expression context (e.g. <return>$$var</return>).
                        
                        This option is available in MongoDB 5.0+ and will result in an exception at
                        execution time if specified for an older server version.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\BulkWrite::count
type: function
doc:
<comment>Description:</comment>
  Count number of write operations in the bulk
  
  Returns the number of write operations added to the <class>MongoDB\Driver\BulkWrite</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns number of write operations added to the <class>MongoDB\Driver\BulkWrite</class> object.


id: MongoDB\Driver\BulkWrite::delete
type: function
doc:
<comment>Description:</comment>
  Add a delete operation to the bulk
  
  Adds a delete operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         El predicado de la consulta. Un predicado vacío coincidirá con todos
                                los documentos de una colección.
                                
                                Al evaluar criterios de consulta, MongoDB compara tipos y valores
                                según sus propias reglas de comparación para tipos BSON, lo cual
                                difiere de las reglas de comparación y manejo de tipos de PHP. Al
                                encontrar un tipo BSON especial, los criterios de consulta deben
                                utilizar la clase BSON respectiva (p.ej. usar <class>MongoDB\BSON\ObjectID</class>
                                al encontrar un ObjectID).
  <info>array|null</info>    <strong>$deleteOptions</strong>  
                                deleteOptionsOptionTypeDescriptionDefaultcollation<info>array|object</info>Collation,
                                o cotejamiento, permite a los usuarios especificar reglas específcas
                                del lenguaje para comparar cadenas, tales como reglas para
                                mayúsculas/minúsculas y marcas de acento. Cuando se especifica el
                                cotejamiento, el cambpo <return>"locale"</return> es obligatorio; todos los demás
                                campos de cotejamiento son opcionales. Para la descripción de los
                                campos, véase la Documentación de Collation.  Si no se especifica el
                                cotejamiento y la colección tiene un cotejamiento predeterminado, la
                                operación usará el cotejamiento especificado por la colección. Si no
                                se especifica el cotejamiento para la colección o para la operación,
                                MongoDB usará la comparación binaria simple utilizada en versiones
                                anteriores para comparar cadenas.  Esta opción está disponible en
                                MongoDB 3.4+ y resultará en una excepción durante la ejecución si se
                                especifica para una versión más antigua del servidor.
                                hint<info>string</info><info>array</info><info>object</info></info> Index specification. Specify either the index
                                name as a string or the index key pattern. If specified, then the
                                query system will only consider plans using the hinted index.  This
                                option is available in MongoDB 4.4+ and will result in an exception
                                at execution time if specified for an older server version.
                                limit<info>bool</info>Delete all matching documents (<info>false</info>), or only the first
                                matching document (<info>true</info>)<info>false</info>
                                
                                Collation, o cotejamiento, permite a los usuarios especificar reglas
                                específcas del lenguaje para comparar cadenas, tales como reglas
                                para mayúsculas/minúsculas y marcas de acento. Cuando se especifica
                                el cotejamiento, el cambpo <return>"locale"</return> es obligatorio; todos los demás
                                campos de cotejamiento son opcionales. Para la descripción de los
                                campos, véase la Documentación de Collation.
                                
                                Si no se especifica el cotejamiento y la colección tiene un
                                cotejamiento predeterminado, la operación usará el cotejamiento
                                especificado por la colección. Si no se especifica el cotejamiento
                                para la colección o para la operación, MongoDB usará la comparación
                                binaria simple utilizada en versiones anteriores para comparar
                                cadenas.
                                
                                Esta opción está disponible en MongoDB 3.4+ y resultará en una
                                excepción durante la ejecución si se especifica para una versión más
                                antigua del servidor.
                                
                                Index specification. Specify either the index name as a string or
                                the index key pattern. If specified, then the query system will only
                                consider plans using the hinted index.
                                
                                This option is available in MongoDB 4.4+ and will result in an
                                exception at execution time if specified for an older server
                                version.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\BulkWrite::insert
type: function
doc:
<comment>Description:</comment>
  Add an insert operation to the bulk
  
  Adds an insert operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$document</strong>  A document to insert.

<comment>Return:</comment>
  <info>mixed</info>  Returns the <return>_id</return> of the inserted document. If the <strong>$document</strong> did not have an <return>_id</return>, the
         <class>MongoDB\BSON\ObjectId</class> generated for the insert will be returned.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\BSON\ObjectId</class>
   * MongoDB\BSON\Persistable


id: MongoDB\Driver\BulkWrite::update
type: function
doc:
<comment>Description:</comment>
  Add an update operation to the bulk
  
  Adds an update operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         El predicado de la consulta. Un predicado vacío coincidirá con todos
                                los documentos de una colección.
                                
                                Al evaluar criterios de consulta, MongoDB compara tipos y valores
                                según sus propias reglas de comparación para tipos BSON, lo cual
                                difiere de las reglas de comparación y manejo de tipos de PHP. Al
                                encontrar un tipo BSON especial, los criterios de consulta deben
                                utilizar la clase BSON respectiva (p.ej. usar <class>MongoDB\BSON\ObjectID</class>
                                al encontrar un ObjectID).
  <info>array|object</info>  <strong>$newObj</strong>         A document containing either update operators (e.g. <return>$set</return>), a
                                replacement document (i.e. only <return>field:value</return> expressions), or an
                                aggregation pipeline.
  <info>array|null</info>    <strong>$updateOptions</strong>  updateOptionsOptionTypeDescriptionDefaultarrayFilters<info>array</info> An array
                                of filter documents that determines which array elements to modify
                                for an update operation on an array field. See Specify arrayFilters
                                for Array Update Operations in the MongoDB manual for more
                                information.  This option is available in MongoDB 3.6+ and will
                                result in an exception at execution time if specified for an older
                                server version. collation<info>array|object</info>Collation, o cotejamiento,
                                permite a los usuarios especificar reglas específcas del lenguaje
                                para comparar cadenas, tales como reglas para mayúsculas/minúsculas
                                y marcas de acento. Cuando se especifica el cotejamiento, el cambpo
                                <return>"locale"</return> es obligatorio; todos los demás campos de cotejamiento son
                                opcionales. Para la descripción de los campos, véase la
                                Documentación de Collation.  Si no se especifica el cotejamiento y
                                la colección tiene un cotejamiento predeterminado, la operación
                                usará el cotejamiento especificado por la colección. Si no se
                                especifica el cotejamiento para la colección o para la operación,
                                MongoDB usará la comparación binaria simple utilizada en versiones
                                anteriores para comparar cadenas.  Esta opción está disponible en
                                MongoDB 3.4+ y resultará en una excepción durante la ejecución si se
                                especifica para una versión más antigua del servidor.
                                hint<info>string</info><info>array</info><info>object</info></info> Index specification. Specify either the index
                                name as a string or the index key pattern. If specified, then the
                                query system will only consider plans using the hinted index.  This
                                option is available in MongoDB 4.2+ and will result in an exception
                                at execution time if specified for an older server version.
                                multi<info>bool</info> Update only the first matching document if <info>false</info>, or all
                                matching documents <info>true</info>. This option cannot be <info>true</info> if <strong>$newObj</strong> is a
                                replacement document. <info>false</info>upsert<info>bool</info> If <strong>$filter</strong> does not match an
                                existing document, insert a single document. The document will be
                                created from <strong>$newObj</strong> if it is a replacement document (i.e. no update
                                operators); otherwise, the operators in <strong>$newObj</strong> will be applied to
                                <strong>$filter</strong> to create the new document. <info>false</info>
                                
                                An array of filter documents that determines which array elements to
                                modify for an update operation on an array field. See Specify
                                arrayFilters for Array Update Operations in the MongoDB manual for
                                more information.
                                
                                This option is available in MongoDB 3.6+ and will result in an
                                exception at execution time if specified for an older server
                                version.
                                
                                Collation, o cotejamiento, permite a los usuarios especificar reglas
                                específcas del lenguaje para comparar cadenas, tales como reglas
                                para mayúsculas/minúsculas y marcas de acento. Cuando se especifica
                                el cotejamiento, el cambpo <return>"locale"</return> es obligatorio; todos los demás
                                campos de cotejamiento son opcionales. Para la descripción de los
                                campos, véase la Documentación de Collation.
                                
                                Si no se especifica el cotejamiento y la colección tiene un
                                cotejamiento predeterminado, la operación usará el cotejamiento
                                especificado por la colección. Si no se especifica el cotejamiento
                                para la colección o para la operación, MongoDB usará la comparación
                                binaria simple utilizada en versiones anteriores para comparar
                                cadenas.
                                
                                Esta opción está disponible en MongoDB 3.4+ y resultará en una
                                excepción durante la ejecución si se especifica para una versión más
                                antigua del servidor.
                                
                                Index specification. Specify either the index name as a string or
                                the index key pattern. If specified, then the query system will only
                                consider plans using the hinted index.
                                
                                This option is available in MongoDB 4.2+ and will result in an
                                exception at execution time if specified for an older server
                                version.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\ClientEncryption
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\ClientEncryption</class> class handles creation of data keys for client-side
  encryption, as well as manually encrypting and decrypting values.


id: MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for deterministic encryption, which is suitable for querying.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for an indexed, encrypted payload, which can be used with queryable
  encryption.
  
  To insert or query with an indexed, encrypted payload, the <class>MongoDB\Driver\Manager</class> must be
  configured with the <return>"autoEncryption"</return> driver option. The <return>"bypassQueryAnalysis"</return> auto encryption
  option may be <info>true</info>. The <return>"bypassAutoEncryption"</return> auto encryption option must be <info>false</info>.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for a range, encrypted payload, which can be used with queryable
  encryption.
  
  To query with a range encrypted payload, the <class>MongoDB\Driver\Manager</class> must be configured with the
  <return>"autoEncryption"</return> driver option. The <return>"bypassQueryAnalysis"</return> auto encryption option may be <info>true</info>. The
  <return>"bypassAutoEncryption"</return> auto encryption option must be <info>false</info>.
  
  The range algorithm is experimental only. It is not intended for public use.
  
  The PHP driver does not yet support range queries for decimal128 BSON field types.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY
type: constant
doc:
<comment>Description:</comment>
  Specifies an equality query type, which is used in conjunction with
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info>.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Specifies a range query type, which is used in conjunction with
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.


id: MongoDB\Driver\ClientEncryption::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new ClientEncryption object
  
  Constructs a new <class>MongoDB\Driver\ClientEncryption</class> object with the specified options.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  optionsOptionTypeDescriptionkeyVaultClient<class>MongoDB\Driver\Manager</class>The Manager used
                   to route data key queries. This option is required (unlike with
                   <strong>MongoDB\Driver\Manager::createClientEncryption()</strong>).keyVaultNamespace<info>string</info>A fully
                   qualified namespace (e.g. <return>"databaseName.collectionName"</return>) denoting the collection
                   that contains all data keys used for encryption and decryption. This option is
                   required.kmsProviders<info>array</info> A document containing the configuration for one or
                   more KMS providers, which are used to encrypt data keys. Supported providers
                   include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return>, and <return>"local"</return> and at least one must be
                   specified.  If an empty document is specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the
                   driver will attempt to configure the provider using Automatic Credentials.  The
                   format for <return>"aws"</return> is as follows: , secretAccessKey: , sessionToken:
                   }
                   ]]> The format for <return>"azure"</return> is as follows: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // Defaults to "login.microsoftonline.com"
                   }
                   ]]> The format for <return>"gcp"</return> is as follows: , privateKey: |, endpoint:  // Defaults
                   to "oauth2.googleapis.com"
                   }
                   ]]> The format for <return>"kmip"</return> is as follows: 
                   }
                   ]]> The format for <return>"local"</return> is as follows: |
                   }
                   ]]>tlsOptions<info>array</info> A document containing the TLS configuration for one or more
                   KMS providers. Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All
                   providers support the following options: : { tlsCaFile: , tlsCertificateKeyFile:
                   , tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   A document containing the configuration for one or more KMS providers, which are
                   used to encrypt data keys. Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>,
                   <return>"kmip"</return>, and <return>"local"</return> and at least one must be specified.
                   
                   If an empty document is specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the driver will
                   attempt to configure the provider using Automatic Credentials.
                   
                   The format for <return>"aws"</return> is as follows:
                   
                   The format for <return>"azure"</return> is as follows:
                   
                   The format for <return>"gcp"</return> is as follows:
                   
                   The format for <return>"kmip"</return> is as follows:
                   
                   The format for <return>"local"</return> is as follows:
                   
                   A document containing the TLS configuration for one or more KMS providers.
                   Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All providers
                   support the following options:

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::createClientEncryption()</strong>
   * Explicit (Manual) Client-Side Field Level Encryption in the MongoDB manual


id: MongoDB\Driver\ClientEncryption::addKeyAltName
type: function
doc:
<comment>Description:</comment>
  Adds an alternate name to a key document
  
  Adds <strong>$keyAltName</strong> to the set of alternate names for the key document with the given UUID <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>       A <class>MongoDB\BSON\Binary</class> instance with subtype 4 (UUID) identifying
                                    the key document.
  <info>string</info>               <strong>$keyAltName</strong>  Alternate name to add to the key document.

<comment>Return:</comment>
  <info>object|null</info>  Returns the previous version of the key document, or <info>null</info> if no document matched.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::getKeyByAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::removeKeyAltName()</strong>


id: MongoDB\Driver\ClientEncryption::createDataKey
type: function
doc:
<comment>Description:</comment>
  Creates a key document
  
  Creates a new key document and inserts it into the key vault collection.

<comment>Param:</comment>
  <info>string</info>      <strong>$kmsProvider</strong>  The KMS provider (e.g. <return>"local"</return>, <return>"aws"</return>) that will be used to encrypt the
                            new data key.
  <info>array|null</info>  <strong>$options</strong>      Data key optionsOptionTypeDescriptionmasterKey<info>array</info> The masterKey
                            document identifies a KMS-specific key used to encrypt the new data key.
                            This option is required unless <strong>$kmsProvider</strong> is <return>"local"</return>. <return>"aws"</return> provider
                            optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The
                            Amazon Resource Name (ARN) to the AWS customer master key
                            (CMK).endpointstringOptional. An alternate host identifier to send KMS
                            requests to. May include port number.<return>"azure"</return> provider
                            optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with
                            optional port (e.g.
                            "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional.
                            A specific version of the named key. Defaults to using the key's primary
                            version.<return>"gcp"</return> provider
                            optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional.
                            A specific version of the named key. Defaults to using the key's primary
                            version.endpointstringOptional. Host with optional port. Defaults to
                            "cloudkms.googleapis.com".<return>"kmip"</return> provider
                            optionsOptionTypeDescriptionkeyIdstringOptional. Unique identifier to a
                            96-byte KMIP secret data managed object. If unspecified, the driver
                            creates a random 96-byte KMIP secret data managed
                            object.endpointstringOptional. Host with optional port.keyAltNames<info>array</info>
                            An optional list of string alternate names used to reference a key. If a
                            key is created with alternate names, then encryption may refer to the
                            key by the unique alternate name instead of by <return>_id</return>.
                            keyMaterial<class>MongoDB\BSON\Binary</class> An optional 96-byte value to use as
                            custom key material for the data key being created. If keyMaterial is
                            given, the custom key material is used for encrypting and decrypting
                            data. Otherwise, the key material for the new data key is generated from
                            a cryptographically secure random device.
                            
                            The masterKey document identifies a KMS-specific key used to encrypt the
                            new data key. This option is required unless <strong>$kmsProvider</strong> is <return>"local"</return>.
                            
                            <return>"aws"</return> provider
                            optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The
                            Amazon Resource Name (ARN) to the AWS customer master key
                            (CMK).endpointstringOptional. An alternate host identifier to send KMS
                            requests to. May include port number.
                            
                            <return>"azure"</return> provider
                            optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with
                            optional port (e.g.
                            "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional.
                            A specific version of the named key. Defaults to using the key's primary
                            version.
                            
                            <return>"gcp"</return> provider
                            optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional.
                            A specific version of the named key. Defaults to using the key's primary
                            version.endpointstringOptional. Host with optional port. Defaults to
                            "cloudkms.googleapis.com".
                            
                            <return>"kmip"</return> provider optionsOptionTypeDescriptionkeyIdstringOptional. Unique
                            identifier to a 96-byte KMIP secret data managed object. If unspecified,
                            the driver creates a random 96-byte KMIP secret data managed
                            object.endpointstringOptional. Host with optional port.
                            
                            An optional list of string alternate names used to reference a key. If a
                            key is created with alternate names, then encryption may refer to the
                            key by the unique alternate name instead of by <return>_id</return>.
                            
                            An optional 96-byte value to use as custom key material for the data key
                            being created. If keyMaterial is given, the custom key material is used
                            for encrypting and decrypting data. Otherwise, the key material for the
                            new data key is generated from a cryptographically secure random device.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Returns the identifier of the new key as a <class>MongoDB\BSON\Binary</class> object with
                       subtype 4 (UUID).


id: MongoDB\Driver\ClientEncryption::decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypt a value
  
  Decrypts the value.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$value</strong>  A <class>MongoDB\BSON\Binary</class> instance with subtype 6 containing the
                               encrypted value.

<comment>Return:</comment>
  <info>mixed</info>  Returns the decrypted value as it was passed to <strong>MongoDB\Driver\ClientEncryption::encrypt()</strong>.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::encrypt()</strong>


id: MongoDB\Driver\ClientEncryption::deleteKey
type: function
doc:
<comment>Description:</comment>
  Deletes a key document
  
  Removes the key document with the given UUID <strong>$keyId</strong> from the key vault collection.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>  A <class>MongoDB\BSON\Binary</class> instance with subtype 4 (UUID) identifying the
                               key document.

<comment>Return:</comment>
  <info>object</info>  Returns the result of the internal <return>deleteOne</return> operation on the key vault collection.


id: MongoDB\Driver\ClientEncryption::encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt a value
  
  Encrypts the value.

<comment>Param:</comment>
  <info>mixed</info>       <strong>$value</strong>    The value to be encrypted. Any value that can be inserted into MongoDB can
                        be encrypted using this method.
  <info>array|null</info>  <strong>$options</strong>  Encryption optionsOptionTypeDescriptionalgorithm<info>string</info> The encryption
                        algorithm to be used. This option is required. Specify one of the following
                        ClientEncryption constants:
                        <info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</info><info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>contentionFactor<info>int</info>
                        The contention factor for evaluating queries with indexed, encrypted
                        payloads.  This option only applies and may only be specified when <return>algorithm</return>
                        is <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                        Identifies a key vault collection document by <return>keyAltName</return>. This option is
                        mutually exclusive with <return>keyId</return> and exactly one is required.
                        keyId<class>MongoDB\BSON\Binary</class> Identifies a data key by <return>_id</return>. The value is a UUID
                        (binary subtype 4). This option is mutually exclusive with <return>keyAltName</return> and
                        exactly one is required. queryType<info>int</info> The query type for evaluating queries
                        with indexed, encrypted payloads. Specify one of the following
                        ClientEncryption constants:
                        <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>This
                        option only applies and may only be specified when <return>algorithm</return> is
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                        Index options for a queryable encryption field supporting "rangePreview"
                        queries. The options below must match the values set in the <return>encryptedFields</return>
                        of the target collection. For double and decimal128 BSON field types, <return>min</return>,
                        <return>max</return>, and <return>precision</return> must all be set, or all be unset. Range index
                        optionsOptionTypeDescriptionmin<info>mixed</info>Required if <return>precision</return> is
                        set.max<info>mixed</info>Required if <return>precision</return> is
                        set.sparsity<info>int</info>Required.precision<info>int</info>Optional. May only be set for double or
                        decimal128 BSON field types.
                        
                        The encryption algorithm to be used. This option is required. Specify one of
                        the following ClientEncryption constants:
                        
                        The contention factor for evaluating queries with indexed, encrypted
                        payloads.
                        
                        This option only applies and may only be specified when <return>algorithm</return> is
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Identifies a key vault collection document by <return>keyAltName</return>. This option is
                        mutually exclusive with <return>keyId</return> and exactly one is required.
                        
                        Identifies a data key by <return>_id</return>. The value is a UUID (binary subtype 4). This
                        option is mutually exclusive with <return>keyAltName</return> and exactly one is required.
                        
                        The query type for evaluating queries with indexed, encrypted payloads.
                        Specify one of the following ClientEncryption constants:
                        
                        This option only applies and may only be specified when <return>algorithm</return> is
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Index options for a queryable encryption field supporting "rangePreview"
                        queries. The options below must match the values set in the <return>encryptedFields</return>
                        of the target collection. For double and decimal128 BSON field types, <return>min</return>,
                        <return>max</return>, and <return>precision</return> must all be set, or all be unset.
                        
                        Range index optionsOptionTypeDescriptionmin<info>mixed</info>Required if <return>precision</return> is
                        set.max<info>mixed</info>Required if <return>precision</return> is
                        set.sparsity<info>int</info>Required.precision<info>int</info>Optional. May only be set for double or
                        decimal128 BSON field types.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Returns the encrypted value as <class>MongoDB\BSON\Binary</class> object with subtype 6.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::decrypt()</strong>


