# php_manual

id: imap_getmailboxes
type: function
doc:
<comment>Description:</comment>
  Leer la lista de buzones, devolviendo información detallada de cada uno
  
  Obtiene información sobre los buzones.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$ref</strong>          <strong>$ref</strong> normalmente debería ser la especificación del servidor como está
                        descrita en <strong>imap_open()</strong>
  <info>string</info>  <strong>$pattern</strong>      Especifica donde en la jerarquía del buzón
                        para empezar a buscar.
                        
                        Hay dos caracteres especiales que se pueden
                        pasar como parte del <strong>$pattern</strong>:
                        '<return>*</return>' y '<return>%</return>'.
                        '<return>*</return>' significa devolver todos los buzones. Si se pasa el
                        <strong>$pattern</strong> como '<return>*</return>', se obtendrá
                        una lista de toda la jerarquía del buzón.
                        '<return>%</return>'
                        significa devolver sólo el nivel actual.
                        '<return>%</return>' como el parámetro <strong>$pattern</strong>
                        devolverá solamente el nivel superior de los
                        buzones; '<return>~/mail/%</return>' en <return>UW_IMAPD</return> devolverá cada buzón en el directorio
                        ~/mail, pero no en los subdirectorios de ese directorio.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de objetos que contienen la información de los buzones. Cada objeto tiene
         los atributos <strong>$name</strong> (nombre), especificando el nombre completo del buzón; <strong>$delimiter</strong>
         (delimitador), que es el delimitador de jerarquía de la parte de la jerarquía en la que
         está este buzón, y <strong>$attributes</strong> (atributos). <strong>$Attributes</strong> es una máscara de bits que puede
         comprobar con: <info>LATT_NOINFERIORS</info> - Este buzón contiene, y no puede contener ningún "hijo"
         (no hay buzones por debajo de este). Una llamada a <strong>imap_createmailbox()</strong> no funcionará con
         este buzón. <info>LATT_NOSELECT</info> - Es solo un contenedor, no un buzón - no se puede abrir.
         <info>LATT_MARKED</info> - Este buzón está marcado. Esto significa que puede contener mensajes nuevos
         desde la última vez que se comprobó. No proporcionado por todos los servidores IMAP.
         <info>LATT_UNMARKED</info> - Este buzó no está marcado, no contiene nuevos mensajes. Si se proporciona
         <info>MARKED</info> o <info>UNMARKED</info>, se puede asumir que el servidor IMAP soporta esta característica para
         este buzón.
         
         <info>LATT_NOINFERIORS</info> - Este buzón contiene, y no puede contener ningún "hijo" (no hay buzones
         por debajo de este). Una llamada a <strong>imap_createmailbox()</strong> no funcionará con este buzón.
         
         <info>LATT_NOSELECT</info> - Es solo un contenedor, no un buzón - no se puede abrir.
         
         <info>LATT_MARKED</info> - Este buzón está marcado. Esto significa que puede contener mensajes nuevos
         desde la última vez que se comprobó. No proporcionado por todos los servidores IMAP.
         
         <info>LATT_UNMARKED</info> - Este buzó no está marcado, no contiene nuevos mensajes. Si se proporciona
         <info>MARKED</info> o <info>UNMARKED</info>, se puede asumir que el servidor IMAP soporta esta característica para
         este buzón.

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


id: imap_getsubscribed
type: function
doc:
<comment>Description:</comment>
  Listar todos los buzones suscritos
  
  Obtiene información sobre los buzones suscritos.
  
  Idéntica a <strong>imap_getmailboxes()</strong>, excepto que sólo devuelve los buzones al que está suscrito el
  usuario.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$ref</strong>          <strong>$ref</strong> normalmente debería ser la especificación del servidor como está
                        descrita en <strong>imap_open()</strong>
  <info>string</info>  <strong>$pattern</strong>      Especifica donde en la jerarquía del buzón
                        para empezar a buscar.
                        
                        Hay dos caracteres especiales que se pueden
                        pasar como parte del <strong>$pattern</strong>:
                        '<return>*</return>' y '<return>%</return>'.
                        '<return>*</return>' significa devolver todos los buzones. Si se pasa el
                        <strong>$pattern</strong> como '<return>*</return>', se obtendrá
                        una lista de toda la jerarquía del buzón.
                        '<return>%</return>'
                        significa devolver sólo el nivel actual.
                        '<return>%</return>' como el parámetro <strong>$pattern</strong>
                        devolverá solamente el nivel superior de los
                        buzones; '<return>~/mail/%</return>' en <return>UW_IMAPD</return> devolverá cada buzón en el directorio
                        ~/mail, pero no en los subdirectorios de ese directorio.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de objetos de contienen información de los buzones. Cada objeto tiene los
         atributos <strong>$name</strong> (nombre), especificando el nombre completo del buzón; <strong>$delimiter</strong>
         (delimitador), que es el delimitador de jerarquía para la parte de jerarquía en la que está
         este buzón, y <strong>$attributes</strong> (atributos). <strong>$Attributes</strong> es una máscara de bits que puede ser
         comprobada con: <info>LATT_NOINFERIORS</info> - Este buzón no tiene "hijos" (no hay buzones por debajo
         de este). <info>LATT_NOSELECT</info> - Esto es solo un contenedor, no un buzón - no puede abrirlo.
         <info>LATT_MARKED</info> - Este buzón está marcado. Solo usado por UW-IMAPD. <info>LATT_UNMARKED</info> - Este buzón
         no está marcado. Solo usado por UW-IMAPD.
         
         <info>LATT_NOINFERIORS</info> - Este buzón no tiene "hijos" (no hay buzones por debajo de este).
         
         <info>LATT_NOSELECT</info> - Esto es solo un contenedor, no un buzón - no puede abrirlo.
         
         <info>LATT_MARKED</info> - Este buzón está marcado. Solo usado por UW-IMAPD.
         
         <info>LATT_UNMARKED</info> - Este buzón no está marcado. Solo usado por UW-IMAPD.


id: imap_header
type: function
doc:
<comment>Description:</comment>
  Alias de imap_headerinfo
  
  Esta función es un alias de:  <strong>imap_headerinfo()</strong>.


id: imap_headerinfo
type: function
doc:
<comment>Description:</comment>
  Leer la cabecera del mensaje
  
  Obtiene información sobre el número de mensaje dado leyendo sus cabeceras.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>    IMAP stream devuelto por
                          <strong>imap_open()</strong>.
  <info>int</info>     <strong>$msg_number</strong>     El número de mensaje
  <info>int</info>     <strong>$fromlength</strong>     Número de caracteres para la propiedad <return>fetchfrom</return>. Debe ser mayor que cero
                          o igual a cero.
  <info>int</info>     <strong>$subjectlength</strong>  Número de caracteres para la propiedad <return>fetchsubject</return>. Debe ser mayor que
                          cero o igual a cero.
  <info>string</info>  <strong>$defaulthost</strong>    

<comment>Return:</comment>
  <info>object</info>  Devuelve la información en un objeto con las siguientes propiedades:  toaddress - to
          completo: línea, hasta 1024 caracteres  to - un array de objetos desde To: línea, con las
          siguientes propiedades: <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  fromaddress - from completo:
          línea, hasta 1024 caracteres  from - un array de objetos desde From: línea, con las
          siguientes propiedades: <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  ccaddress - cc completo: línea,
          hasta 1024 caracteres  cc - un array de objetos desde Cc: línea, con las siguientes
          propiedades: <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  bccaddress - bcc completo: línea, hasta 1024
          caracteres  bcc - un array de objetos desde Bcc: línea, con las siguientes propiedades:
          <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  reply_toaddress - Reply-To completo: línea, hasta 1024
          caracteres  reply_to - un array de objetos desde Reply-To: línea, con las siguientes
          propiedades: <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  senderaddress - sender completo: línea, hasta
          1024 caracteres  sender - un array de objetos desde Sender: línea, con las siguientes
          propiedades: <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>  return_pathaddress - Return-Path completo:
          línea, hasta 1024 caracteres  return_path - un array de objetos desde Return-Path: línea,
          con las siguienets propiedades: <return>personal</return>,  <return>adl</return>, <return>mailbox</return>, y  <return>host</return>  remail -   date - La
          fecha del mensaje como se encuentra en sus cabeceras  Date - Lo mismo que date  subject -
          El sujeto del mensaje  Subject - Lo mismo que subject   in_reply_to -   message_id -
          newsgroups -   followup_to -   references -   Recent - <return>R</return> si es reciente y visto, <return>N</return> si es
          reciente y no visto, ' ' si no es reciente.  Unseen - <return>U</return> si no está visto Y no es reciente,
          ' ' si está visto O no visto y es reciente  Flagged - <return>F</return> si está marcado, ' ' si no está
          marcado  Answered - <return>A</return> si está respondido, ' ' si no está respondido  Deleted - <return>D</return> si está
          borrado, ' ' si no está borrado  Draft - <return>X</return> si es un borrador, ' ' si no es un borrador
          Msgno - El número de mensaje  MailDate -   Size - El tamaño del mensaje  udate - fecha del
          mensaje de correo en época Unix  fetchfrom - línea from formateada a encajar <strong>$fromlength</strong>
          caracteres  fetchsubject - línea subject formateada a encajar <strong>$subjectlength</strong> caracteres
          
          toaddress - to completo: línea, hasta 1024 caracteres
          
          to - un array de objetos desde To: línea, con las siguientes propiedades: <return>personal</return>, <return>adl</return>,
          <return>mailbox</return>, y <return>host</return>
          
          fromaddress - from completo: línea, hasta 1024 caracteres
          
          from - un array de objetos desde From: línea, con las siguientes propiedades: <return>personal</return>,
          <return>adl</return>, <return>mailbox</return>, y <return>host</return>
          
          ccaddress - cc completo: línea, hasta 1024 caracteres
          
          cc - un array de objetos desde Cc: línea, con las siguientes propiedades: <return>personal</return>, <return>adl</return>,
          <return>mailbox</return>, y <return>host</return>
          
          bccaddress - bcc completo: línea, hasta 1024 caracteres
          
          bcc - un array de objetos desde Bcc: línea, con las siguientes propiedades: <return>personal</return>, <return>adl</return>,
          <return>mailbox</return>, y <return>host</return>
          
          reply_toaddress - Reply-To completo: línea, hasta 1024 caracteres
          
          reply_to - un array de objetos desde Reply-To: línea, con las siguientes propiedades:
          <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>
          
          senderaddress - sender completo: línea, hasta 1024 caracteres
          
          sender - un array de objetos desde Sender: línea, con las siguientes propiedades:
          <return>personal</return>, <return>adl</return>, <return>mailbox</return>, y <return>host</return>
          
          return_pathaddress - Return-Path completo: línea, hasta 1024 caracteres
          
          return_path - un array de objetos desde Return-Path: línea, con las siguienets
          propiedades: <return>personal</return>,  <return>adl</return>, <return>mailbox</return>, y  <return>host</return>
          
          remail -
          
          date - La fecha del mensaje como se encuentra en sus cabeceras
          
          Date - Lo mismo que date
          
          subject - El sujeto del mensaje
          
          Subject - Lo mismo que subject
          
          in_reply_to -
          
          message_id -
          
          newsgroups -
          
          followup_to -
          
          references -
          
          Recent - <return>R</return> si es reciente y visto, <return>N</return> si es reciente y no visto, ' ' si no es reciente.
          
          Unseen - <return>U</return> si no está visto Y no es reciente, ' ' si está visto O no visto y es reciente
          
          Flagged - <return>F</return> si está marcado, ' ' si no está marcado
          
          Answered - <return>A</return> si está respondido, ' ' si no está respondido
          
          Deleted - <return>D</return> si está borrado, ' ' si no está borrado
          
          Draft - <return>X</return> si es un borrador, ' ' si no es un borrador
          
          Msgno - El número de mensaje
          
          MailDate -
          
          Size - El tamaño del mensaje
          
          udate - fecha del mensaje de correo en época Unix
          
          fetchfrom - línea from formateada a encajar <strong>$fromlength</strong> caracteres
          
          fetchsubject - línea subject formateada a encajar <strong>$subjectlength</strong> caracteres

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


id: imap_headers
type: function
doc:
<comment>Description:</comment>
  Devuelve las cabeceras de todos los mensajes de un buzón
  
  Devuelve las cabeceras de todos los mensajes de un buzón.

<comment>Param:</comment>
  <info></info>  <strong>$imap_stream</strong>  IMAP stream devuelto por
                  <strong>imap_open()</strong>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de cadenas formateadas con la información de cabecera. Un elemento por
         mensaje de correo.


id: imap_is_open
type: function
doc:
<comment>Description:</comment>
  Check if the IMAP stream is still valid
  
  Check if the IMAP stream is still valid.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  An <class>IMAP\Connection</class> instance.

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


id: imap_last_error
type: function
doc:
<comment>Description:</comment>
  Obtiene el último error de IMAP que ocurrió durante esta petición de página
  
  Obtiene el texto completo del últime mensaje de error de IMAP que ocurrión de la página actual. La
  pila de errores se queda intacta; llamar a <strong>imap_last_error()</strong> posteriormente, sin que intervengan
  errores, devolverá el mismo error.

<comment>Return:</comment>
  <info>string</info>  Devuelve el texto completo de último mensaje de error de IMAP que ocurrio en la página
          actual. Devuelve <info>false</info> si no hay disponibles mensajes de error.

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


id: imap_list
type: function
doc:
<comment>Description:</comment>
  Leer la lista de buzones
  
  Leer la lista de buzones.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$ref</strong>          <strong>$ref</strong> normalmente debería ser la especificación del servidor como está
                        descrita en <strong>imap_open()</strong>.
  <info>string</info>  <strong>$pattern</strong>      Especifica donde en la jerarquía del buzón
                        para empezar a buscar.
                        
                        Hay dos caracteres especiales que se pueden
                        pasar como parte del <strong>$pattern</strong>:
                        '<return>*</return>' y '<return>%</return>'.
                        '<return>*</return>' significa devolver todos los buzones. Si se pasa el
                        <strong>$pattern</strong> como '<return>*</return>', se obtendrá
                        una lista de toda la jerarquía del buzón.
                        '<return>%</return>'
                        significa devolver sólo el nivel actual.
                        '<return>%</return>' como el parámetro <strong>$pattern</strong>
                        devolverá solamente el nivel superior de los
                        buzones; '<return>~/mail/%</return>' en <return>UW_IMAPD</return> devolverá cada buzón en el directorio
                        ~/mail, pero no en los subdirectorios de ese directorio.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene los nombres de los buzones.

<comment>See Also:</comment>
   * <strong>imap_getmailboxes()</strong>
   * <strong>imap_lsub()</strong>


id: imap_listmailbox
type: function
doc:
<comment>Description:</comment>
  Alias de imap_list
  
  Esta función es un alias de:  <strong>imap_list()</strong>.


id: imap_listscan
type: function
doc:
<comment>Description:</comment>
  Devuelve la lista de buzones que coinciden con el texto dado
  
  Devuelve un array que contiene los nombres de los buzones que tienen el contenido dado por
  <strong>$content</strong> en el texto del buzón.
  
  Esta función es similar a <strong>imap_listmailbox()</strong>, excepto que verificará además la presencia de la
  cadena <strong>$content</strong> dentro de la información del buzón.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$ref</strong>          <strong>$ref</strong> normalmente debería ser la especificación del servidor como está
                        descrita en <strong>imap_open()</strong>
  <info>string</info>  <strong>$pattern</strong>      Especifica donde en la jerarquía del buzón
                        para empezar a buscar.
                        
                        Hay dos caracteres especiales que se pueden
                        pasar como parte del <strong>$pattern</strong>:
                        '<return>*</return>' y '<return>%</return>'.
                        '<return>*</return>' significa devolver todos los buzones. Si se pasa el
                        <strong>$pattern</strong> como '<return>*</return>', se obtendrá
                        una lista de toda la jerarquía del buzón.
                        '<return>%</return>'
                        significa devolver sólo el nivel actual.
                        '<return>%</return>' como el parámetro <strong>$pattern</strong>
                        devolverá solamente el nivel superior de los
                        buzones; '<return>~/mail/%</return>' en <return>UW_IMAPD</return> devolverá cada buzón en el directorio
                        ~/mail, pero no en los subdirectorios de ese directorio.
  <info>string</info>  <strong>$content</strong>      La cadena buscada

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene los nombres de los buzones que tienen el contenido dado por
         <strong>$content</strong> en el texto del buzón.

<comment>See Also:</comment>
   * <strong>imap_listmailbox()</strong>
   * <strong>imap_search()</strong>


id: imap_listsubscribed
type: function
doc:
<comment>Description:</comment>
  Alias de imap_lsub
  
  Esta función es un alias de:  <strong>imap_lsub()</strong>.


id: imap_lsub
type: function
doc:
<comment>Description:</comment>
  Listar todos los buzones suscritos
  
  Obtiene un array de todos lo buzones que tiene suscritos.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$ref</strong>          <strong>$ref</strong> normalmente debería ser la especificación del servidor como está
                        descrita en <strong>imap_open()</strong>
  <info>string</info>  <strong>$pattern</strong>      Especifica donde en la jerarquía del buzón
                        para empezar a buscar.
                        
                        Hay dos caracteres especiales que se pueden
                        pasar como parte del <strong>$pattern</strong>:
                        '<return>*</return>' y '<return>%</return>'.
                        '<return>*</return>' significa devolver todos los buzones. Si se pasa el
                        <strong>$pattern</strong> como '<return>*</return>', se obtendrá
                        una lista de toda la jerarquía del buzón.
                        '<return>%</return>'
                        significa devolver sólo el nivel actual.
                        '<return>%</return>' como el parámetro <strong>$pattern</strong>
                        devolverá solamente el nivel superior de los
                        buzones; '<return>~/mail/%</return>' en <return>UW_IMAPD</return> devolverá cada buzón en el directorio
                        ~/mail, pero no en los subdirectorios de ese directorio.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de todos los buzones suscritos.

<comment>See Also:</comment>
   * <strong>imap_list()</strong>
   * <strong>imap_getmailboxes()</strong>


id: imap_mail
type: function
doc:
<comment>Description:</comment>
  Enviar un mensaje de correo electrónico
  
  Esta función permite enviar emails con el manejo correcto de los destinatarios Cc y Bcc.
  
  Los parámetros <strong>$to</strong>, <strong>$cc</strong> y <strong>$bcc</strong> son todos strings y son analizados como la lista de direcciones
  RFC822.

<comment>Param:</comment>
  <info>string</info>  <strong>$to</strong>                  El destinatario
  <info>string</info>  <strong>$subject</strong>             El asunto del correo
  <info>string</info>  <strong>$message</strong>             El cuerpo del correo, véase <strong>imap_mail_compose()</strong>
  <info>string</info>  <strong>$additional_headers</strong>  Como string con cabeceras adicionales para ser establecidas en el
                               correo
  <info>string</info>  <strong>$cc</strong>                  
  <info>string</info>  <strong>$bcc</strong>                 Los destinatarios especificados en <strong>$bcc</strong> recibirán el correo, pero son
                               excluidos de las cabeceras.
  <info>string</info>  <strong>$rpath</strong>               Use este parámetro para especificar la ruta de vuelta si la entrega
                               del corro falla. Esto es útil al usar PHP como un cliente de correo
                               para múltiples usuarios.

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


id: imap_mail_compose
type: function
doc:
<comment>Description:</comment>
  Crear un mensaje MIME basado en las secciones sobre y cuerpo
  
  Crear un mensaje MIME basado en las secciones de sobre dado por <strong>$envelope</strong> y cuerpo dado por <strong>$body</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$envelope</strong>  Un array asociativo de campos de cabecers. Las claves válidas son: "remail",
                    "return_path", "date", "from", "reply_to", "in_reply_to", "subject", "to", "cc",
                    "bcc", "message_id" y "custom_headers" (que contiene un array asociativo de
                    otras cabeceras).
  <info>array</info>  <strong>$body</strong>      Un array indexado de cuerpos
                    
                    Un cuero en un array asociativo que puede consistir en las siguientes claves:
                    "type", "encoding", "charset", "type.parameters", "subtype", "id",
                    "description", "disposition.type", "disposition", "contents.data", "lines",
                    "bytes" y "md5".

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


id: imap_mail_copy
type: function
doc:
<comment>Description:</comment>
  Copiar los mensajes especificados a un buzón
  
  Copia los mensajes de correo especificados por <strong>$msglist</strong> al buzón especificado.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$msglist</strong>      <strong>$msglist</strong> es un rango, no números de mensajes (como está descrito en
                        RFC2060).
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>int</info>     <strong>$options</strong>      <strong>$options</strong> es una máscara de bits de un o más de <info>CP_UID</info> - los números de
                        secuencia conetienen UIDS <info>CP_MOVE</info> - Borrar los mensajes del buzón actual
                        después de copiar
                        
                        <info>CP_UID</info> - los números de secuencia conetienen UIDS
                        
                        <info>CP_MOVE</info> - Borrar los mensajes del buzón actual después de copiar

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


id: imap_mail_move
type: function
doc:
<comment>Description:</comment>
  Mover los mensajes especificados a un buzón
  
  Mueve los mensajes de correo especificados por <strong>$msglist</strong> al buzón especificado por <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$msglist</strong>      <strong>$msglist</strong> es un rango, y no números de mensajes (como está descrito en
                        RFC2060).
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>int</info>     <strong>$options</strong>      <strong>$options</strong> es una máscara de bits y puede contener la única opción: <info>CP_UID</info> -
                        los números de secuencia que contienen UIDS
                        
                        <info>CP_UID</info> - los números de secuencia que contienen UIDS

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


id: imap_mailboxmsginfo
type: function
doc:
<comment>Description:</comment>
  Obtener información sobre el buzón actual
  
  Comprueba el estado del buzón actual del servidor. Es similar a <strong>imap_status()</strong>, excepto que
  resumirá el tamaño de todos los mensajes del buzón, lo que tomará algún tiempo adicional para
  ejecutarse.

<comment>Param:</comment>
  <info></info>  <strong>$imap_stream</strong>  IMAP stream devuelto por
                  <strong>imap_open()</strong>.

<comment>Return:</comment>
  <info>object</info>  Devuelve la información en un objeto con las siguientes propiedades: Propiedades del
          buzónDatefecha del último cambio (fecha/hora actuales)DrivercontroladorMailboxnombre del
          buzónNmsgsnúmero de mensajesRecentnúmero de mensajes recientesUnreadnúmero de mensajes no
          leídosDeletednúmero de mensajes eliminadosSizetamaño del buzón
          
          Devuelve <info>false</info> en caso de error.


id: imap_mime_header_decode
type: function
doc:
<comment>Description:</comment>
  Decodificar los elementos de la cabecera MIME
  
  Decodifica las extensiones de la cabecera del mensaje MIME que no son texto ASCII (véase RFC2047).

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  El texto MIME

<comment>Return:</comment>
  <info>array</info>  Los elementos decodificados son devueltos como un array de objetos, donde cada objeto tiene
         dos propiedades, <return>charset</return> y <return>text</return>.
         
         Si el elemento no ha sido codificado, y en otras palabras está en US-ASCII plano, la
         propiedad <return>charset</return> de ese elemento está establecida a <return>default</return>.

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


id: imap_msgno
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de secuencia de mensaje para el UID dado
  
  Devuelve el número de secuencia de mensaje para el <strong>$uid</strong> dado.
  
  Esta función es la inversa de <strong>imap_uid()</strong>.

<comment>Param:</comment>
  <info></info>     <strong>$imap_stream</strong>  IMAP stream devuelto por
                     <strong>imap_open()</strong>.
  <info>int</info>  <strong>$uid</strong>          El UID del mensaje

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de secuencia de mensaje para el <strong>$uid</strong> dado.

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


id: imap_mutf7_to_utf8
type: function
doc:
<comment>Description:</comment>
  Decode a modified UTF-7 string to UTF-8
  
  Decode a modified UTF-7 (as specified in RFC 2060, section 5.1.3) string to UTF-8.
  
  This function is only available, if libcclient exports utf8_to_mutf7().

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string encoded in modified UTF-7.

<comment>Return:</comment>
  <info>string|false</info>  Returns <strong>$string</strong> converted to UTF-8, o <info>false</info> en caso de error.

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


id: imap_num_msg
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de mensajes del buzón actual
  
  Obtiene el número de mensajes del buzón actual.

<comment>Param:</comment>
  <info></info>  <strong>$imap_stream</strong>  IMAP stream devuelto por
                  <strong>imap_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de mensajes del buzón actual, como un integer.

<comment>See Also:</comment>
   * <strong>imap_num_recent()</strong>
   * <strong>imap_status()</strong>


id: imap_num_recent
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de mensajes recientes en el buzón actual
  
  Obtiene el número de mensajes recientes en el buzón actual.

<comment>Param:</comment>
  <info></info>  <strong>$imap_stream</strong>  IMAP stream devuelto por
                  <strong>imap_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de mensajes recientes en el buzón actual, como un integer.

<comment>See Also:</comment>
   * <strong>imap_num_msg()</strong>
   * <strong>imap_status()</strong>


id: imap_open
type: function
doc:
<comment>Description:</comment>
  Abrir un flujo IMAP a un buzón
  
  Abre un flujo IMAP a un buzón dado por <strong>$mailbox</strong>.
  
  Esta función también se puede usar para abrir flujos a servidores POP3 y NNTP, pero sólo algunas
  funciones y características están disponibles en servidores IMAP.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>    Un nombre de buzón consiste en una ruta de servidor y una de buzón para este
                      servidor. El nombre especial <return>INBOX</return> permanece para los buzones personales de
                      ususarios actuales. Los nombres de buzón que contienen caracteres
                      internacionales además de aquellos imprimibles del espacio ASCII tienen que
                      ser codificados con <strong>imap_utf7_encode()</strong>.
                      
                      La ruta del servidor, que está encerrada entre '{' y '}', consiste en los
                      nombres de los servidores o direcciones ip, y el puerto opcional (prefijado
                      por ':'), y una especificación de protocolo opcional (prefijada por '/').
                      
                      La parte del servidor el obligatoria en todos los parámetros del buzón.
                      
                      Todos los nombres que empiezan con <return>{</return> son nombres remotos, y están en la forma
                      <return>"{" nombre_sistema_remoto [":" puerto] [banderas] "}" [nombre_buzón]</return> donde:
                      <return>nombre_sistema_remoto</return> - -Nombre de dominio de internet o dirección IP del
                      servidor entre corchetes. <return>port</return> - número de puerto TCP opcional, por omisión es
                      el puerto por defecto para ese servicio <return>flags</return> - banderas opcionales, véase la
                      siguiente tabla. <return>mailbox_name</return> - nombre del buzón remoto, por defecto es INBOX
                      
                      <return>nombre_sistema_remoto</return> - -Nombre de dominio de internet o dirección IP del
                      servidor entre corchetes.
                      
                      <return>port</return> - número de puerto TCP opcional, por omisión es el puerto por defecto
                      para ese servicio
                      
                      <return>flags</return> - banderas opcionales, véase la siguiente tabla.
                      
                      <return>mailbox_name</return> - nombre del buzón remoto, por defecto es INBOX
                      
                      Banderas opcionales para los
                      nombresBanderaDescricpción<return>/service=</return>servicioservicio de acceso al buzón, por
                      defecto es "imap"<return>/user=</return>usuarionombre de usuario remoto para identificar en el
                      servidor<return>/authuser=</return>usuariousuario de autentificación remoto; si se especifica
                      es el nombre de usuario cuya contraseña es usada (p.ej.
                      administrador)<return>/anonymous</return>acceso remoto como usuario anónimo<return>/debug</return>grabar la
                      telemetría de protocolo en el registro de depuración de la aplicación<return>/secure</return>no
                      transmitir una contraseña en texto plano en la red<return>/imap</return>, <return>/imap2</return>, <return>/imap2bis</return>,
                      <return>/imap4</return>, <return>/imap4rev1</return>equivalente a <return>/service=imap</return><return>/pop3</return>equivalente a
                      <return>/service=pop3</return><return>/nntp</return>equivalente a <return>/service=nntp</return><return>/norsh</return>no usar rsh o ssh para
                      establecer una sesión de IMAP preautenticada<return>/ssl</return>usar <return>Secure Socket Layer</return> (Capa
                      de Conexión Segura) para encriptar la sesión<return>/validate-cert</return>validar certificados
                      desde el servidor TLS/SSL (este es el comportamiento
                      predeterminado)<return>/novalidate-cert</return>no validar certificador desde el servidor
                      TLS/SSL, necesario si el servidor usa certificados autofirmados<return>/tls</return>forzar el
                      uso de <return>start-TLS</return> para encriptar la sesión, y rechazar la conexión a servidores
                      que no la soportan<return>/notls</return>no realizar <return>start-TLS</return> para encriptar la sesión,
                      incluso con los servidores que la soportan<return>/readonly</return>petición de apertura de un
                      buzón de sólo lectura (sólo IMAP; ignorado en NNTP, y un error con SMTP y
                      POP3)
  <info>string</info>  <strong>$username</strong>   El nombre de usuario
  <info>string</info>  <strong>$password</strong>   La contraseña asociada con <strong>$username</strong>
  <info>int</info>     <strong>$options</strong>    <strong>$options</strong> es una máscara de bits con uno o más de lo siguiente: <info>OP_READONLY</info> -
                      Abrir un buzón de sólo lectura <info>OP_ANONYMOUS</info> - No usar o actualizar un .newsrc
                      para noticias (sólo NNTP) <info>OP_HALFOPEN</info> - Para nombres IMAP y NNTP, abrir una
                      conexión pero no abrir el buzón. <info>CL_EXPUNGE</info> - Expurgar el buzón
                      automáticamente al cierre del mismo (véase también <strong>imap_delete()</strong> y
                      <strong>imap_expunge()</strong>) <info>OP_DEBUG</info> - Depurar negociaciones de protocolo <info>OP_SHORTCACHE</info> -
                      Almacenamiento en caché corto (sólo <return>elt</return>) <info>OP_SILENT</info> - No dejar pasar eventos
                      (uso interno) <info>OP_PROTOTYPE</info> - Devolver el prototipo de controlador <info>OP_SECURE</info> -
                      No realizar autenticación no segura
                      
                      <info>OP_READONLY</info> - Abrir un buzón de sólo lectura
                      
                      <info>OP_ANONYMOUS</info> - No usar o actualizar un .newsrc para noticias (sólo NNTP)
                      
                      <info>OP_HALFOPEN</info> - Para nombres IMAP y NNTP, abrir una conexión pero no abrir el
                      buzón.
                      
                      <info>CL_EXPUNGE</info> - Expurgar el buzón automáticamente al cierre del mismo (véase
                      también <strong>imap_delete()</strong> y <strong>imap_expunge()</strong>)
                      
                      <info>OP_DEBUG</info> - Depurar negociaciones de protocolo
                      
                      <info>OP_SHORTCACHE</info> - Almacenamiento en caché corto (sólo <return>elt</return>)
                      
                      <info>OP_SILENT</info> - No dejar pasar eventos (uso interno)
                      
                      <info>OP_PROTOTYPE</info> - Devolver el prototipo de controlador
                      
                      <info>OP_SECURE</info> - No realizar autenticación no segura
  <info>int</info>     <strong>$n_retries</strong>  Número máximo de intentos de conexión
  <info>array</info>   <strong>$params</strong>     Parámetros de conexión, las siguientes claves (cadena) pueden usarse para
                      establecer uno o más parámetros de conexión: <return>DISABLE_AUTHENTICATOR</return> -
                      Deshabilitar las propieades de autenticación
                      
                      <return>DISABLE_AUTHENTICATOR</return> - Deshabilitar las propieades de autenticación

<comment>Return:</comment>
  <info>resource</info>  Devuelve un flujo IMAP en caso de éxito o <info>false</info> en caso de error.

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


id: imap_ping
type: function
doc:
<comment>Description:</comment>
  Comprobar si el flujo de IMAP está aún activo
  
  <strong>imap_ping()</strong> realiza un ping al flujo para ver si aún está activo. Puede descubrir nuevos correos;
  este es el método preferido para una "comporbación de nuevos correos" periódica así como para
  "mantenerlo vivo" para servidores que tienen un tiempo límite de inactividad.

<comment>Param:</comment>
  <info></info>  <strong>$imap_stream</strong>  IMAP stream devuelto por
                  <strong>imap_open()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el flujo está aún activo, <info>false</info> si no.


id: imap_qprint
type: function
doc:
<comment>Description:</comment>
  Convertir una cadena imprimible entrecomillada a una cadena de 8 bits
  
  Convertir una cadena imprimible entrecomillada a una cadena de 8 bits según RFC2045, sección 6.7.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Una cadena imprimible entrecomillada

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena de 8 bits.

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


id: imap_rename
type: function
doc:
<comment>Description:</comment>
  Alias de imap_renamemailbox
  
  Esta función es un alias de:  <strong>imap_renamemailbox()</strong>.


id: imap_renamemailbox
type: function
doc:
<comment>Description:</comment>
  Renombrar un buzón antiguo a un buzón nuevo
  
  Esta función renombra un buzón antiguo a un buzón nuevo (véase <strong>imap_open()</strong> para el formato de los
  nombres de <strong>$mbox</strong>).

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$old_mbox</strong>     El nombre antiguo del buzón, véase <strong>imap_open()</strong> para más información
  <info>string</info>  <strong>$new_mbox</strong>     El nuevo nombre del buzón, véase <strong>imap_open()</strong> 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.

<comment>See Also:</comment>
   * <strong>imap_createmailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_reopen
type: function
doc:
<comment>Description:</comment>
  Reabrir un flujo IMAP hacia un nuevo buzón
  
  Reabre el flujo espeicificado a un nuevo buzón dado por <strong>$mailbox</strong> sobre un servidor IMAP o NNTP.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>int</info>     <strong>$options</strong>      <strong>$options</strong> es una máscara de bits con uno o más de lo siguiente: <info>OP_READONLY</info> -
                        Abrir el buzón en sólo lectura <info>OP_ANONYMOUS</info> - No usar o actualizar un
                        .newsrc para noticias (sólo NNTP) <info>OP_HALFOPEN</info> - Para nombres IMAP y NNTP,
                        abrir una conexión pero no abrir un buzón. <info>OP_EXPUNGE</info> - Expurgar y reciclar
                        el flujo de manera silenciosa <info>CL_EXPUNGE</info> - Expurgar el buzón automáticamente
                        al cierre del mismo (véase también <strong>imap_delete()</strong> y <strong>imap_expunge()</strong>)
                        
                        <info>OP_READONLY</info> - Abrir el buzón en sólo lectura
                        
                        <info>OP_ANONYMOUS</info> - No usar o actualizar un .newsrc para noticias (sólo NNTP)
                        
                        <info>OP_HALFOPEN</info> - Para nombres IMAP y NNTP, abrir una conexión pero no abrir un
                        buzón.
                        
                        <info>OP_EXPUNGE</info> - Expurgar y reciclar el flujo de manera silenciosa
                        
                        <info>CL_EXPUNGE</info> - Expurgar el buzón automáticamente al cierre del mismo (véase
                        también <strong>imap_delete()</strong> y <strong>imap_expunge()</strong>)
  <info>int</info>     <strong>$n_retries</strong>    Número máximo de intentos de conexion

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el flujo es reabierto, <info>false</info> si no.


id: imap_rfc822_parse_adrlist
type: function
doc:
<comment>Description:</comment>
  Analiza una cadena de dirección
  
  Analiza la cadena de dirección como está definido en RFC2822 y para cada dirección.

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>       Una cadena que contiene direcciones
  <info>string</info>  <strong>$default_host</strong>  El nombre del host predeterminado

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de objetos. Las propiedades de los objetos son:
         
          mailbox  - el nombre del buzón (nombre de usuario)  host - el nombre del host  personal -
         el nombre personal  adl - ruta fuente del dominio
         
         mailbox  - el nombre del buzón (nombre de usuario)
         
         host - el nombre del host
         
         personal - el nombre personal
         
         adl - ruta fuente del dominio

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


id: imap_rfc822_parse_headers
type: function
doc:
<comment>Description:</comment>
  Analizar cabeceras de correo desde una cadena
  
  Obtiene un objeto de varios elementos de cabecera, similar a <strong>imap_header()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$headers</strong>      La información de las cabeceras analizadas
  <info>string</info>  <strong>$defaulthost</strong>  El nombre del host predeterminado

<comment>Return:</comment>
  <info>object</info>  Devuelve un objeto similar al devuelto por <strong>imap_header()</strong>, excepto por las banderas y otras
          propiedades que vienen del servidor IMAP.

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


id: imap_rfc822_write_address
type: function
doc:
<comment>Description:</comment>
  Devuelve una dirección de correo correctamente formateada dados el buzón, host e información
  personal
  
  Devuelve una dirección de correo correctamente formateada como está definido en RFC2822 dada la
  información necesaria.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>string</info>  <strong>$host</strong>      La parte del host del correo
  <info>string</info>  <strong>$personal</strong>  El nombre del propietario de la cuenta

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena de dirección de correo correctamente formateada como está definido en
          RFC2822.


id: imap_savebody
type: function
doc:
<comment>Description:</comment>
  Guardar una sección del cuerpo específica en un fichero
  
  Guarda una parte del cuerpo completo de un mensaje especificado.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>mixed</info>   <strong>$file</strong>         La ruta al fichero guardado como una cadena, o un descriptor de fichero
                        válido devuelto por <strong>fopen()</strong>.
  <info>int</info>     <strong>$msg_number</strong>   El número de mensaje
  <info>string</info>  <strong>$part_number</strong>  El número de parte. Es una cadena de enteros delimitada por puntos que
                        indexa a una lista de partes de cuerpos como por la especificación IMAP4
  <info>int</info>     <strong>$options</strong>      Una máscara de bits de uno o más de lo siguiente: <info>FT_UID</info> - <strong>$msg_number</strong> es un
                        UID <info>FT_PEEK</info> - No establecer la bandera \Seen si no lo está ya <info>FT_INTERNAL</info> -
                        La cadena devuelta está en formato intermo, no canonizará a CRLF.
                        
                        <info>FT_UID</info> - <strong>$msg_number</strong> es un UID
                        
                        <info>FT_PEEK</info> - No establecer la bandera \Seen si no lo está ya
                        
                        <info>FT_INTERNAL</info> - La cadena devuelta está en formato intermo, no canonizará a
                        CRLF.

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


id: imap_scan
type: function
doc:
<comment>Description:</comment>
  Alias de imap_listscan
  
  Esta función es un alias de:  <strong>imap_listscan()</strong>.


id: imap_search
type: function
doc:
<comment>Description:</comment>
  Esta función devuelve un array de mensajes que coinciden con el criterio de búsqueda dado
  
  Esta función realiza una búsqueda en el buzón actualmente abierto en el flujo IMAP dado.
  
  Por ejemplo, para hacer coincidir todos los mensajes no respondidos por Mami, debería usar:
  "UNANSWERED FROM mami". La búsqueda parece ser insensible a mayúsculas-minúsculas. La lista de
  criterios viene dada por una lectura del código fuente de c-client UW y puede estar incompleta o
  no ser exacta (véase RFC2060,  sección 6.4.4).

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$criteria</strong>     Una cadena, delimitada por espacios, en la que están permitidas las
                        siguientes palabras clave. Cualquier argumento multi-palabra (p.ej. <return>FROM
                        "joey smith"</return>) debe encerrarse entre comillas. Los resultados serán contra
                        todos los parámetros del campo <strong>$criteria</strong>.  ALL - devuelve todos los mensajes
                        que coinciden con el resto del criterio  ANSWERED - coincide con los
                        mensajes con la bandera \\ANSWERED establecida  BCC "cadena" - coincide con
                        los mensajes con "cadena" en el campo Bcc:  BEFORE "fecha" - coincide con
                        los mensajes con Date: antes de "fecha"  BODY "cadena" - coincide con los
                        mensajes con "cadena" en el cuerpo del mensaje  CC "cadena" - coincide con
                        los mensajes con "cadena" en el campo Cc:  DELETED - coincide con los
                        mensajes borrados  FLAGGED - coincide con los mensajes con la bandera
                        \\FLAGGED establecida (algunas veces referidos como Importante o Urgente)
                        FROM "cadena" - coincide con los mensajes con "cadena" en el campo From:
                        KEYWORD "cadena" - coincide con los mensajes con "cadena" como palabra clave
                        NEW - coincide con los mensajes nuevos  OLD - coincide con los mensajes
                        antiguos  ON "fecha" - coincide con los mensajes con Date: coincidiendo con
                        "fecha"  RECENT - coincide con los mensajes con la bandera \\RECENT
                        establecida  SEEN - coincide con los mensajes que han sido leídos (la
                        bandera \\SEEN está estabecido)  SINCE "fecha" - coincide con los mensajes
                        con Date: después de "fecha"  SUBJECT "cadena" - coincide con los mensajes
                        con "cadena" en Subject:  TEXT "cadena" - coincide con los mensajes con el
                        texto "cadena"  TO "cadena" - coincide con los mensajes con "cadena" en To:
                        UNANSWERED - coincide con los mensajes que no han sido respondidos
                        UNDELETED - coincide con los mensajes que no están eliminados  UNFLAGGED -
                        coincide con los mensajes que no tienen bandera  UNKEYWORD "cadena" -
                        coincide con los mensajes que no tienen la palabra clave "cadena"  UNSEEN -
                        coincide con los mensajes que aún no han sido leídos
                        
                        ALL - devuelve todos los mensajes que coinciden con el resto del criterio
                        
                        ANSWERED - coincide con los mensajes con la bandera \\ANSWERED establecida
                        
                        BCC "cadena" - coincide con los mensajes con "cadena" en el campo Bcc:
                        
                        BEFORE "fecha" - coincide con los mensajes con Date: antes de "fecha"
                        
                        BODY "cadena" - coincide con los mensajes con "cadena" en el cuerpo del
                        mensaje
                        
                        CC "cadena" - coincide con los mensajes con "cadena" en el campo Cc:
                        
                        DELETED - coincide con los mensajes borrados
                        
                        FLAGGED - coincide con los mensajes con la bandera \\FLAGGED establecida
                        (algunas veces referidos como Importante o Urgente)
                        
                        FROM "cadena" - coincide con los mensajes con "cadena" en el campo From:
                        
                        KEYWORD "cadena" - coincide con los mensajes con "cadena" como palabra clave
                        
                        NEW - coincide con los mensajes nuevos
                        
                        OLD - coincide con los mensajes antiguos
                        
                        ON "fecha" - coincide con los mensajes con Date: coincidiendo con "fecha"
                        
                        RECENT - coincide con los mensajes con la bandera \\RECENT establecida
                        
                        SEEN - coincide con los mensajes que han sido leídos (la bandera \\SEEN está
                        estabecido)
                        
                        SINCE "fecha" - coincide con los mensajes con Date: después de "fecha"
                        
                        SUBJECT "cadena" - coincide con los mensajes con "cadena" en Subject:
                        
                        TEXT "cadena" - coincide con los mensajes con el texto "cadena"
                        
                        TO "cadena" - coincide con los mensajes con "cadena" en To:
                        
                        UNANSWERED - coincide con los mensajes que no han sido respondidos
                        
                        UNDELETED - coincide con los mensajes que no están eliminados
                        
                        UNFLAGGED - coincide con los mensajes que no tienen bandera
                        
                        UNKEYWORD "cadena" - coincide con los mensajes que no tienen la palabra
                        clave "cadena"
                        
                        UNSEEN - coincide con los mensajes que aún no han sido leídos
  <info>int</info>     <strong>$options</strong>      Los valores válidos para <strong>$options</strong> son <info>SE_UID</info>, que causa que el array
                        devuelto contenga UIDs en vez de números de secuencia de mensajes.
  <info>string</info>  <strong>$charset</strong>      Conjunto de caracteres MIME a utilizar cuando se ordenan cadenas.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de números de mensajes o UIDs.
         
         Devuelve <info>false</info> si no comprende el criterio de búsqueda dado por <strong>$criteria</strong> o no se han
         encontrado mensajes.

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


id: imap_set_quota
type: function
doc:
<comment>Description:</comment>
  Establece una cuota para un buzón dado
  
  Establece una cuota de límite superior sobre una base por buzón.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$quota_root</strong>   El buzón que tiene una cuota a establecer. Debería seguir el formato
                        estándar de IMAP para un buzón: <return>user.name</return>.
  <info>int</info>     <strong>$quota_limit</strong>  El tamaño máximo (en KB) para <strong>$quota_root</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>imap_open()</strong>
   * <strong>imap_get_quota()</strong>


id: imap_setacl
type: function
doc:
<comment>Description:</comment>
  Establece el ACL para el buzón dado
  
  Establece el ACL para un buzón dado.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>string</info>  <strong>$id</strong>           El ususario al que dar los derechos.
  <info>string</info>  <strong>$rights</strong>       Los derechos a dar al usuario. Al pasar una cadena vacía borrará acl.

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


id: imap_setflag_full
type: function
doc:
<comment>Description:</comment>
  Establece banderas en mensajes
  
  Realiza un almacenaje para añadir la bandera especificada por <strong>$flag</strong> al conjunto de banderas para
  los mensajes en la secuencia especificada por <strong>$sequence</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$sequence</strong>     Una secuencia de números de mensaje. Puede enumerar los mensajes deseados
                        con la sintaxis <return>X,Y</return>, o recuperar todos los mensajes dentro de un intervalo
                        con la sintaxis <return>X:Y</return>
  <info>string</info>  <strong>$flag</strong>         Las banderas que se pueden establecer son <return>\Seen</return>,  <return>\Answered</return>, <return>\Flagged</return>,
                        <return>\Deleted</return>, y <return>\Draft</return> como estaá definido en RFC2060.
  <info>int</info>     <strong>$options</strong>      Una máscara de bits que puede contener la única opción: <info>ST_UID</info> - El
                        argumento sequence contiene UIDs en lugar de números de secuencia
                        
                        <info>ST_UID</info> - El argumento sequence contiene UIDs en lugar de números de
                        secuencia

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


id: imap_sort
type: function
doc:
<comment>Description:</comment>
  Obtiene y ordena mensajes
  
  Obtiene y ordena números de mensajes según los parámetros dados.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>      IMAP stream devuelto por
                            <strong>imap_open()</strong>.
  <info>int</info>     <strong>$criteria</strong>         El criterio puede ser un (y sólo uno) de los siguientes: <info>SORTDATE</info> - Date
                            (fecha) del mensaje <info>SORTARRIVAL</info> - fecha de llegada <info>SORTFROM</info> - buzón en
                            la primera dirección From (De) <info>SORTSUBJECT</info> - asunto del mensaje <info>SORTTO</info> -
                            buzón en la primera dirección To (Para) <info>SORTCC</info> - buzón en la primera
                            dirección cc <info>SORTSIZE</info> - tamaño del mensaje en octetos
                            
                            <info>SORTDATE</info> - Date (fecha) del mensaje
                            
                            <info>SORTARRIVAL</info> - fecha de llegada
                            
                            <info>SORTFROM</info> - buzón en la primera dirección From (De)
                            
                            <info>SORTSUBJECT</info> - asunto del mensaje
                            
                            <info>SORTTO</info> - buzón en la primera dirección To (Para)
                            
                            <info>SORTCC</info> - buzón en la primera dirección cc
                            
                            <info>SORTSIZE</info> - tamaño del mensaje en octetos
  <info>int</info>     <strong>$reverse</strong>          Establezca esto a 1 para ordenación inversa
  <info>int</info>     <strong>$options</strong>          <strong>$options</strong> es una máscara de bits de uno o más de lo siguiente: <info>SE_UID</info> -
                            Devolver UIDs en vez de números de secuencia <info>SE_NOPREFETCH</info> - No
                            preobtener mensajes buscados
                            
                            <info>SE_UID</info> - Devolver UIDs en vez de números de secuencia
                            
                            <info>SE_NOPREFETCH</info> - No preobtener mensajes buscados
  <info>string</info>  <strong>$search_criteria</strong>  Cadena de criterios de búsqueda en formato IMAP2. Véase <strong>imap_search()</strong>
                            para más detalles.
  <info>string</info>  <strong>$charset</strong>          Conjunto de caracteres MIME a utilizar cuando se ordenan cadenas.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de números de mensajes ordenados según los parámetros dados.


id: imap_status
type: function
doc:
<comment>Description:</comment>
  Devuelve la información de estado de un buzón
  
  Obtiene la información de estado sobre el buzón dado por <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> para más información
  <info>int</info>     <strong>$options</strong>      Las banderas válidas son: <info>SA_MESSAGES</info> - establece $estado-&gt;messages al
                        número de mensajes del buzón <info>SA_RECENT</info> - establece $estado-&gt;recent al
                        número de mensajes recientes del buzón <info>SA_UNSEEN</info> - establece
                        $estado-&gt;unseen al número de mensajes no vistos (nuevos) del buzón
                        <info>SA_UIDNEXT</info> - establece $estado-&gt;uidnext al siguiente uid a usar del buzón
                        <info>SA_UIDVALIDITY</info> - establece $estado-&gt;uidvalidity a la constante que cambia
                        cuando los uids para el buzón ya no pueden ser válidos <info>SA_ALL</info> - establece
                        todo lo anterior
                        
                        <info>SA_MESSAGES</info> - establece $estado-&gt;messages al número de mensajes del buzón
                        
                        <info>SA_RECENT</info> - establece $estado-&gt;recent al número de mensajes recientes del
                        buzón
                        
                        <info>SA_UNSEEN</info> - establece $estado-&gt;unseen al número de mensajes no vistos
                        (nuevos) del buzón
                        
                        <info>SA_UIDNEXT</info> - establece $estado-&gt;uidnext al siguiente uid a usar del buzón
                        
                        <info>SA_UIDVALIDITY</info> - establece $estado-&gt;uidvalidity a la constante que cambia
                        cuando los uids para el buzón ya no pueden ser válidos
                        
                        <info>SA_ALL</info> - establece todo lo anterior

<comment>Return:</comment>
  <info>object</info>  Esta función devuelve un objeto que contiene la infomación de estado. El objeto tiene las
          siguientes propiedades: <return>messages</return>, <return>recent</return>, <return>unseen</return>,  <return>uidnext</return>, y <return>uidvalidity</return>.
          
          <return>flags</return> también está establecido, contiene una máscara de bits que puede ser comprobada con
          cualquiera de las contastes de arriba.


id: imap_subscribe
type: function
doc:
<comment>Description:</comment>
  Suscribirse a un buzón
  
  Suscribirse a un buzón nuevo.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> 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.

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


id: imap_thread
type: function
doc:
<comment>Description:</comment>
  Devuelve un árbol de mensajes hilados
  
  Obtiene un árbol de mensajes hilados.

<comment>Param:</comment>
  <info></info>     <strong>$imap_stream</strong>  IMAP stream devuelto por
                     <strong>imap_open()</strong>.
  <info>int</info>  <strong>$options</strong>      

<comment>Return:</comment>
  <info>array</info>  <strong>imap_thread()</strong> devuelve un array asociativo que contiene un árbol de mensajes hilados
         mediante <return>REFERENCES</return>, o <info>false</info> en caso de error.
         
         Cada mensaje del buzón actual será representado por tres entradas en el array resultante:
         $thread["XX.num"] - número de mensaje actual $thread["XX.next"]$thread["XX.branch"]
         
         $thread["XX.num"] - número de mensaje actual
         
         $thread["XX.next"]
         
         $thread["XX.branch"]


id: imap_timeout
type: function
doc:
<comment>Description:</comment>
  Establece o obtiene el tiempo de espera de imap
  
  Establece o obtiene el tiempo de espera de imap.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_type</strong>  Uno de los siguientes tipos: <info>IMAP_OPENTIMEOUT</info>, <info>IMAP_READTIMEOUT</info>,
                      <info>IMAP_WRITETIMEOUT</info>, o <info>IMAP_CLOSETIMEOUT</info>.
  <info>int</info>  <strong>$timeout</strong>       El tiempo de espera, en segundos.

<comment>Return:</comment>
  <info>mixed</info>  Si se establece el parámetro <strong>$timeout</strong>, esta función devuelve <info>true</info> en caso de éxito y <info>false</info>
         en caso de error.
         
         Si no se proporciona <strong>$timeout</strong> o se evalúa a -1, se devuelve el valor del tiempo de espera
         de <strong>$timeout_type</strong> como un valor de tipo entero.


id: imap_uid
type: function
doc:
<comment>Description:</comment>
  Esta función devuelve el UID del número de secuencia del mensaje dado
  
  Esta función devuelve el UID del número de secuencia del mensaje dado. Un UID es un identificador
  único que no cambiará durante el tiempo mientras que un número de secuencia de un mensaje puede
  cambiar si el contenido del buzón cambia.
  
  Esta función es la inversa de <strong>imap_msgno()</strong>.

<comment>Param:</comment>
  <info></info>     <strong>$imap_stream</strong>  IMAP stream devuelto por
                     <strong>imap_open()</strong>.
  <info>int</info>  <strong>$msg_number</strong>   El número de mensaje.

<comment>Return:</comment>
  <info>int</info>  EL UID del mensaje dado.

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


id: imap_undelete
type: function
doc:
<comment>Description:</comment>
  Desmarcar el mensaje que está marcado para borrar
  
  Elimina la bandera de borrado de un mensaje especificado, que está establecida mediante
  <strong>imap_delete()</strong> o <strong>imap_mail_move()</strong>.

<comment>Param:</comment>
  <info></info>     <strong>$imap_stream</strong>  IMAP stream devuelto por
                     <strong>imap_open()</strong>.
  <info>int</info>  <strong>$msg_number</strong>   EL número de mensaje
  <info>int</info>  <strong>$flags</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>imap_delete()</strong>
   * <strong>imap_mail_move()</strong>


id: imap_unsubscribe
type: function
doc:
<comment>Description:</comment>
  Cancelar la inscripción de un buzón
  
  Cancela la inscripción del buzón especificado por <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$imap_stream</strong>  IMAP stream devuelto por
                        <strong>imap_open()</strong>.
  <info>string</info>  <strong>$mailbox</strong>      El nombre del buzón, véase <strong>imap_open()</strong> 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.

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


id: imap_utf7_decode
type: function
doc:
<comment>Description:</comment>
  Decodifica una cadena codificada con UTF-7 modificado
  
  Decodifica el parámetro <strong>$text</strong> UTF-7 modificado en una cadena ISO-8859-1.
  
  Esta función es necesaria para decodificar nombres de buzones que contienen ciertos caracteres que
  no están en el rango de caracteres imprimibles de ASCII.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Una cadena codificada UTF-7 modificado, como está definido en RFC 2060, sección
                 5.1.3 (el UTF-7 original fue definido en RFC1642).

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena que está codificada en ISO-8859-1 y consisite en la misma secuencia de
          caracteres de <strong>$text</strong>, o <info>false</info> si <strong>$text</strong> contiene una secuencia UTF-7 modificado no válida o
          <strong>$text</strong> contiene un carácter que no es parte del conjunto de caracteres ISO-8859-1.

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


id: imap_utf7_encode
type: function
doc:
<comment>Description:</comment>
  Convierte una cadena ISO-8859-1 a un texto UTF-7 modifiicado
  
  Convierte <strong>$data</strong> a texto UTF-7 modificado.
  
  Esto es necesario para codificar nombres de buzones que contienen ciertos caracteres que no están
  en el conjunto de caracters imprimibles de ASCII.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Una cadena ISO-8859-1.

<comment>Return:</comment>
  <info>string</info>  Devuelve <strong>$data</strong> codificado con la codificación UTF-7 modificada como está definido en RFC
          2060,  sección 5.1.3 (el UTF-7 original fue definido en RFC1642).

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


id: imap_utf8
type: function
doc:
<comment>Description:</comment>
  Convierte texto codificado MIME en UTF-8
  
  Convierte el parámetro dado por <strong>$mime_encoded_text</strong> en UTF-8.

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_encoded_text</strong>  Una cadena codificada MIME. El método de codificación MIME y la
                              especificación UTF-8 están descritas en RFC2047 y RFC2044
                              respectivamente.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena codificada en UTF-8.

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


id: imap_utf8_to_mutf7
type: function
doc:
<comment>Description:</comment>
  Encode a UTF-8 string to modified UTF-7
  
  Encode a UTF-8 string to modified UTF-7 (as specified in RFC 2060, section 5.1.3).
  
  This function is only available, if libcclient exports utf8_to_mutf7().

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

<comment>Return:</comment>
  <info>string|false</info>  Returns <strong>$string</strong> converted to modified UTF-7, o <info>false</info> en caso de error.

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


id: implode
type: function
doc:
<comment>Description:</comment>
  Une elementos de un array en un string
  
  Firma alternativa (no se admite argumentos con nombre):
  
  Firma heredada (obsoleta a partir de PHP 7.4.0, eliminada a partir de PHP 8.0.0):
  
  Une los elementos de un array con el string <strong>$separator</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Opcional. Por defecto es un string vacío.
  <info>array</info>   <strong>$array</strong>      El array de strings a ser usados por implode.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string que contiene la representación de todos los elementos del array en el
          mismo orden, con el string 'glue' entre cada elemento.

<comment>See Also:</comment>
   * <strong>explode()</strong>
   * <strong>preg_split()</strong>
   * <strong>http_build_query()</strong>


id: in_array
type: function
doc:
<comment>Description:</comment>
  Comprueba si un valor existe en un array
  
  Busca la aguja (<strong>$needle</strong>) en el pajar (<strong>$haystack</strong>) usando una comparación flexible a menos que esté
  establecido <strong>$strict</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$needle</strong>    El valor a buscar.
                    
                    Si <strong>$needle</strong> es un string, la comparación se realiza considerando las
                    mayúsculas/minúsculas.
  <info>array</info>  <strong>$haystack</strong>  El array.
  <info>bool</info>   <strong>$strict</strong>    Si el tercer parámetro <strong>$strict</strong> está establecido a <info>true</info>, la función <strong>in_array()</strong>
                    también comprobará los  tipos de  <strong>$needle</strong> en <strong>$haystack</strong>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$needle</strong> se encuentra en el array, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>array_search()</strong>
   * <strong>isset()</strong>
   * <strong>array_key_exists()</strong>


id: inet_ntop
type: function
doc:
<comment>Description:</comment>
  Convertir una dirección de internet empaquetada en una representación legible por humanos
  
  Esta función convierte una dirección IPv4 de 32 bit, o una dirección IPv6 de 128 bit (si PHP se
  construyó con soporte habilitado para IPv6) a una representación de string apropiada para ser
  legible por humanos.

<comment>Param:</comment>
  <info>string</info>  <strong>$in_addr</strong>  Una dirección IPv4 de 32 bit, o una dirección IPv6 de 128 bit.

<comment>Return:</comment>
  <info>string</info>  Devuelve una representación de string de la dirección  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>ip2long()</strong>
   * <strong>inet_pton()</strong>


id: inet_pton
type: function
doc:
<comment>Description:</comment>
  Convertir una dirección IP legible por humanos a su representación in_addr empaquetada
  
  Esta función convierte una dirección IPv4 o IPv6 legible por humanos (si PHP se construyó con
  soporte habilitado para IPv6) a una estructura binaria de 32 o 128 bit apropiada.

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>  Una dirección IPv4 o IPv6 legible por humanos.

<comment>Return:</comment>
  <info>string</info>  Devuelve la representación <return>in_addr</return> de la dirección dada por <strong>$address</strong>, o <info>false</info> si se
          prorpocionó <strong>$address</strong> sintácticamente inválido (por ejemplo, una dirección IPv4 sin puntos
          o una dirección IPv6 si dos puntos).

<comment>See Also:</comment>
   * <strong>ip2long()</strong>
   * <strong>long2ip()</strong>
   * <strong>inet_ntop()</strong>


id: inflate_add
type: function
doc:
<comment>Description:</comment>
  Incrementally inflate encoded data
  
  Incrementally inflates encoded data in the specified <strong>$context</strong>.
  
  Limitation: header information from GZIP compressed data are not made available.

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>     A context created with <strong>inflate_init()</strong>.
  <info>string</info>          <strong>$data</strong>        A chunk of compressed data.
  <info>int</info>             <strong>$flush_mode</strong>  One of <info>ZLIB_BLOCK</info>, <info>ZLIB_NO_FLUSH</info>, <info>ZLIB_PARTIAL_FLUSH</info>, <info>ZLIB_SYNC_FLUSH</info>
                               (default), <info>ZLIB_FULL_FLUSH</info>, <info>ZLIB_FINISH</info>. Normally you will want to
                               set <info>ZLIB_NO_FLUSH</info> to maximize compression, and <info>ZLIB_FINISH</info> to
                               terminate with the last chunk of data. See the zlib manual for a
                               detailed description of these constants.

<comment>Return:</comment>
  <info>string|false</info>  Returns a chunk of uncompressed data,  o <info>false</info> en caso de error.

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


id: inflate_get_read_len
type: function
doc:
<comment>Description:</comment>
  Get number of bytes read so far
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>int</info>  Returns number of bytes read so far o <info>false</info> en caso de error.


id: inflate_get_status
type: function
doc:
<comment>Description:</comment>
  Get decompression status
  
  Usually returns either <info>ZLIB_OK</info> or <info>ZLIB_STREAM_END</info>.

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>int</info>  Returns decompression status.


id: inflate_init
type: function
doc:
<comment>Description:</comment>
  Initialize an incremental inflate context
  
  Initialize an incremental inflate context with the specified <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$encoding</strong>  One of the <info>ZLIB_ENCODING_*</info> constants.
  <info>array</info>  <strong>$options</strong>   An associative array which may contain the following elements: level The
                    compression level in range -1..9; defaults to -1. memory The compression memory
                    level in range 1..9; defaults to 8. window The zlib window size (logarithmic) in
                    range 8..15; defaults to 15. strategy One of <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>,
                    <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> or <info>ZLIB_DEFAULT_STRATEGY</info> (the default). dictionary A <info>string</info>
                    or an <info>array</info> of <info>strings</info> of the preset dictionary (default: no preset dictionary).
                    
                    The compression level in range -1..9; defaults to -1.
                    
                    The compression memory level in range 1..9; defaults to 8.
                    
                    The zlib window size (logarithmic) in range 8..15; defaults to 15.
                    
                    One of <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> or
                    <info>ZLIB_DEFAULT_STRATEGY</info> (the default).
                    
                    A <info>string</info> or an <info>array</info> of <info>strings</info> of the preset dictionary (default: no preset
                    dictionary).

<comment>Return:</comment>
  <info>InflateContext|false</info>  Returns an inflate context resource (<return>zlib.inflate</return>) on success,  o <info>false</info> en
                        caso de error.

<comment>See Also:</comment>
   * <strong>inflate_add()</strong>
   * <strong>deflate_init()</strong>


id: ini_alter
type: function
doc:
<comment>Description:</comment>
  Alias de ini_set
  
  Esta función es un alias de:  <strong>ini_set()</strong>.


id: ini_get
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de una directiva de configuración
  
  En caso de éxito devuelve el valor de una directiva de configuración.

<comment>Param:</comment>
  <info>string</info>  <strong>$varname</strong>  Nombre de la directiva de configuración.

<comment>Return:</comment>
  <info>string</info>  Devuelve el valor de la opción de configuración como cadena en caso de éxito, o una cadena
          vacía para valores <return>null</return>. Devuelve <info>false</info> si la opción de configuración no existe.

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>


id: ini_get_all
type: function
doc:
<comment>Description:</comment>
  Obtiene todas las opciones de configuración
  
  Devuelve todas las opciones de configuración registradas.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  Un nombre de extensión opcional. Si se establece, la función de retornará
                      únicamente  opciones específicas para esa extensión.
  <info>bool</info>    <strong>$details</strong>    Recupera los detalles de configuración o sólo el valor actual de cada
                      configuración. Por omisión es <info>true</info> (recuperar detalles).

<comment>Return:</comment>
  <info>array</info>  Devuelve un array asociativo con el nombre de la directiva como la clave del array.
         
         Cuando el parámetro <strong>$details</strong> es <info>true</info> (por omisión) el array  contendrá <return>global_value</return>
         (establecido en php.ini), <return>local_value</return>  (tal vez establecido con <strong>ini_set()</strong> o .htaccess), y
         <return>access</return>  (el nivel de acceso).
         
         Cuando el parámetro <strong>$details</strong> es <info>false</info> el valor será el  valor actual de la opción.
         
         Vea la sección del manual  para obtener información sobre lo que significan los niveles de
         acceso.
         
         Es posible que una directiva tenga múltiples niveles de acceso,  por lo que el <return>access</return>
         muestra los valores de máscara de bits adecuado.

<comment>See Also:</comment>
   * 
   * <strong>ini_get()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>phpinfo()</strong>
   * ReflectionExtension::getINIEntries


id: ini_parse_quantity
type: function
doc:
<comment>Description:</comment>
  Get interpreted size from ini shorthand syntax
  
  Returns the interpreted size in bytes on success from an ini shorthand.

<comment>Param:</comment>
  <info>string</info>  <strong>$shorthand</strong>  Ini shorthand to parse, must be a number followed by an optional multiplier.
                       The following multipliers are supported: <return>k</return>/<return>K</return> (<return>1024</return>), <return>m</return>/<return>M</return> (<return>1048576</return>), <return>g</return>/<return>G</return>
                      (<return>1073741824</return>).
                       The number can be a decimal, hex (prefixed with <return>0x</return> or <return>0X</return>), octal (prefixed
                      with <return>0o</return>, <return>0O</return> or <return>0</return>) or binary (prefixed with <return>0b</return> or <return>0B</return>)

<comment>Return:</comment>
  <info>int</info>  Returns the interpreted size in bytes as an <info>int</info>.

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


id: ini_restore
type: function
doc:
<comment>Description:</comment>
  Restablece el valor de una opción de configuración
  
  Restaura una opción de configuración dado su valor original.

<comment>Param:</comment>
  <info>string</info>  <strong>$varname</strong>  El nombre de la opción de configuración.

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

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_set()</strong>


id: ini_set
type: function
doc:
<comment>Description:</comment>
  Establece el valor de una directiva de configuración
  
  Establece el valor de la directiva de configuración dada. La opción de configuración mantendrá
  este nuevo valor durante la ejecución del script, y se restaurará cuando acabe el mismo.

<comment>Param:</comment>
  <info>string</info>  <strong>$varname</strong>   No todas las directivas pueden ser modificadas con <strong>ini_set()</strong>. Hay una lista con
                     todas las directivas disponibles en el apéndice.
  <info>string</info>  <strong>$newvalue</strong>  El nuevo valor para la opción.

<comment>Return:</comment>
  <info>string</info>  Devuelve el valor anterior en caso de éxito, <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * Cómo cambiar los ajustes de configuración


id: inotify_add_watch
type: function
doc:
<comment>Description:</comment>
  Añade un seguimiento a una instancia inotify inicializada
  
  <strong>inotify_add_watch()</strong> añade un nuevo seguimiento o modifica un seguimiento existente para el fichero
  o directorio especificado en <strong>$pathname</strong>.
  
  Usando <strong>inotify_add_watch()</strong> sobre un objeto observado reemplaza el seguimiento existente.
  Utilizando la constante <info>IN_MASK_ADD</info> añade eventos al seguimiento existente.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Recurso devuelto por
                               <strong>inotify_init()</strong>
  <info>string</info>    <strong>$pathname</strong>          Fichero o directorio a observar
  <info>int</info>       <strong>$mask</strong>              Eventos para observar. Ver Constantes predefinidas.

<comment>Return:</comment>
  <info>int</info>  The return value is a unique (inotify instance wide) watch descriptor. El valor devuelto es
       un descriptor de seguimiento único.

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


id: inotify_init
type: function
doc:
<comment>Description:</comment>
  Inicializa una instancia inotify
  
  Inicializar una instancia inotify para usar con <strong>inotify_add_watch()</strong>

<comment>Return:</comment>
  <info>resource</info>  Un recurso de secuencia o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>inotify_add_watch()</strong>
   * <strong>inotify_rm_watch()</strong>
   * <strong>inotify_queue_len()</strong>
   * <strong>inotify_read()</strong>
   * <strong>fclose()</strong>


id: inotify_queue_len
type: function
doc:
<comment>Description:</comment>
  Devuelve un número superior a cero si hay eventos pendientes
  
  Esta función permite saber si <strong>inotify_read()</strong> bloqueará o no. Si un número superior a cero es
  devuelto, hay eventos pendientes e <strong>inotify_read()</strong> no bloqueará.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Recurso devuelto por
                               <strong>inotify_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Devuelve un número superior a cero si hay eventos pendientes.

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>


id: inotify_read
type: function
doc:
<comment>Description:</comment>
  Lee eventos de una instancia inotify
  
  Leer eventos inotify de una instancia inotify.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Recurso devuelto por
                               <strong>inotify_init()</strong>

<comment>Return:</comment>
  <info>array</info>  Un array de eventos inotify o <info>false</info> si no hay eventos pendientes e <strong>$inotify_instance</strong> no es
         de bloqueo. Cada evento es un array con las siguientes claves: wd es un descriptor de
         seguimiento devuelto por <strong>inotify_add_watch()</strong>mask es una máscara de bits de eventoscookie es
         un identificador único para conectar los eventos relacionados (por ejemplo: <info>IN_MOVE_FROM</info> e
         <info>IN_MOVE_TO</info>)name es el nombre de un fichero (por ejemplo: si un fichero se ha modificado en
         un directorio observado)

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>inotify_queue_len()</strong>


id: inotify_rm_watch
type: function
doc:
<comment>Description:</comment>
  Elimina un seguimiento existente de una instancia inotify
  
  <strong>inotify_rm_watch()</strong> elimina el seguimiento <strong>$watch_descriptor</strong> de la instancia inotify
  <strong>$inotify_instance</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Recurso devuelto por
                               <strong>inotify_init()</strong>
  <info>int</info>       <strong>$watch_descriptor</strong>  Seguimiento a eliminar de la instancia

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


id: intdiv
type: function
doc:
<comment>Description:</comment>
  División entera
  
  Devuelve el cociente entero de la división de <strong>$dividend</strong> entre <strong>$divisor</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$dividend</strong>  El número a dividir.
  <info>int</info>  <strong>$divisor</strong>   El número que divide a <strong>$dividend</strong>

<comment>Return:</comment>
  <info>int</info>  El cociente entero de la división de <strong>$dividend</strong> entre <strong>$divisor</strong>.


id: interface_exists
type: function
doc:
<comment>Description:</comment>
  Comprueba si una interfaz ha sido definida
  
  Comprueba si la interfaz dada ha sido definida.

<comment>Param:</comment>
  <info>string</info>  <strong>$interface_name</strong>  El nombre de la interfaz
  <info>bool</info>    <strong>$autoload</strong>        Si llamar a __autoload o no por defecto.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la interfaz dada por <strong>$interface_name</strong> ha sido definida, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>get_declared_interfaces()</strong>
   * <strong>class_implements()</strong>
   * <strong>class_exists()</strong>


id: intl_error_name
type: function
doc:
<comment>Description:</comment>
  Obtiene un nombre simbólico a partir de un código de error dado
  
  Devuelve el nombre del código de error ICU.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Código de error ICU.

<comment>Return:</comment>
  <info>string</info>  El string devuelto será el mismo que el nombre de la constante del código de error.

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


id: intl_get_error_code
type: function
doc:
<comment>Description:</comment>
  Obtiene el último código de error
  
  Útil para controlar los errores acaecidos en los métodos estáticos cuando no hay un objeto para
  obtener el código de error de ellos.

<comment>Return:</comment>
  <info>int</info>  Devolución del código de error por la última llamada a la función API.

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_message()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: intl_get_error_message
type: function
doc:
<comment>Description:</comment>
  Obtener una descripción del último error
  
  Obtener el mensaje de error de la última llamada a la función internacionalizada.

<comment>Return:</comment>
  <info>string</info>  Descripción de un error sucedido en la última llamada a la función API.

<comment>See Also:</comment>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>
   * <strong>collator_get_error_message()</strong>
   * <strong>numfmt_get_error_message()</strong>


id: intl_is_failure
type: function
doc:
<comment>Description:</comment>
  Comprueba si el código de error dado indica un fallo
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  es un valor devuelto por las funciones: <strong>intl_get_error_code()</strong>,
                    <strong>collator_get_error_code()</strong> .

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el código indica algún fallo, y <info>false</info> en caso de éxito o de advertencia.

<comment>See Also:</comment>
   * <strong>intl_get_error_code()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>Collator-getErrorCode()</strong>


id: intval
type: function
doc:
<comment>Description:</comment>
  Obtiene el valor entero de una variable
  
  Devuelve el valor <info>integer</info> de una <strong>$var</strong>, con la especificada <strong>$base</strong> para la conversión (por defecto
  es base 10). No debería ser usado en objetos, si es usado emitirá un error de nivel <info>E_NOTICE</info> y
  devolverá 1.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   El valor escalar a convertir a un entero
  <info>int</info>    <strong>$base</strong>  La base para la conversión
                
                Si <strong>$base</strong> es 0, la base usada estará determinada por el formato de <strong>$var</strong>:  si el
                string incuye el prefijo "0x" (o "0X"), la base se tomará como 16 (hex); si no,  si
                el string comienza con "0", la base se tomará como 8 (octal); si no,  la base se
                toma como 10 (decimal).
                
                si el string incuye el prefijo "0x" (o "0X"), la base se tomará como 16 (hex); si
                no,
                
                si el string comienza con "0", la base se tomará como 8 (octal); si no,
                
                la base se toma como 10 (decimal).

<comment>Return:</comment>
  <info>int</info>  El valor entero de <strong>$var</strong> en caso de éxito, o 0 en caso de error. Arrays vacíos devuelven 0,
       arrays no vacíos devuelven 1.
       
       El valor máximo depende del sistema. Los sistemas de 32 bits tienen un  rango máximo para un
       entero con signo que va desde -2147483648 a 2147483647. Así, por ejemplo,  en tal sistema,
       <return>intval('1000000000000')</return> devolverá  2147483647. El valor máximo para un entero con signo en
       sistemas de 64 bits es 9223372036854775807.
       
       Las cadenas muy probablemente devolverán 0, aunque esto depende de los  carácteres del
       extremo izquierdo de la cadena. Aplican las reglas comunes para  moldeado de enteros.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * <strong>is_numeric()</strong>
   * Manipulación de tipos
   * Funciones matemáticas de precisión arbitraria de BCMath


id: ip2long
type: function
doc:
<comment>Description:</comment>
  Convierte una cadena que contiene una dirección con puntos del Protocolo de Internet (IPv4) en una
  dirección apropiada
  
  La función <strong>ip2long()</strong> genera una dirección de red Internet IPv4 desde su representación en formato
  estándar de Internet (cadena con puntos).
  
  <strong>ip2long()</strong> trabajará también con direcciones IP no-completas. Lea
  http://ps-2.kev009.com/wisclibrary/aix52/usr/share/man/info/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm
  para más información.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip_address</strong>  Una dirección en formato estándar.

<comment>Return:</comment>
  <info>int</info>  Devuelve la dirección IPv4 o <info>false</info> si <strong>$direccion_ip</strong> es un valor inválido.

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>sprintf()</strong>


id: iptcembed
type: function
doc:
<comment>Description:</comment>
  Incluir información IPTC binaria en una imagen JPEG
  
  Incluye información IPTC binaria en una imagen JPEG.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptcdata</strong>        La información que va a ser escrita.
  <info>string</info>  <strong>$jpeg_file_name</strong>  Ruta a la imagen JPEG.
  <info>int</info>     <strong>$spool</strong>           Bandera de spool. Si la bandera de spool es menor que 2, el JPEG será
                           devuelto como una cadena. De lo contrario el JPEG será enviado a STDOUT.

<comment>Return:</comment>
  <info>mixed</info>  Si <strong>$spool</strong> es menor que 2, se devolverá el JPEG, o <info>false</info> en caso de error. De lo contrario
         devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: iptcparse
type: function
doc:
<comment>Description:</comment>
  Conviertir un bloque IPTC binario en simples etiquetas
  
  Convierte un bloque IPTC en sus etiquetas.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptcblock</strong>  Un bloque IPTC binario.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz usando el marcador de etiquetas como un índice, y el valor como el
         valor. Devuelve <info>false</info> si se produjo un error o si no se encontró información IPTC.


id: is_a
type: function
doc:
<comment>Description:</comment>
  Comprueba si un objeto es de una clase o tiene esta clase como una de sus madres
  
  Comprueba si el objeto dado por <strong>$object</strong> es de esta clase o tiene esta clase como una de sus
  madres.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object</strong>        Un nombre de clase o una instancia de objeto.
  <info>string</info>  <strong>$class_name</strong>    El nombre de la clase
  <info>bool</info>    <strong>$allow_string</strong>  Si este parámetro se establece a <info>false</info>, no se permite una cadena de nombre
                         de la clase como <strong>$object</strong>. Esto también evita llamar al autocargador si la
                         clase no existe.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el objeto es de esta clase o tiene esta clase como una de sus madres, <info>false</info>
        si no.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_subclass_of()</strong>


id: is_array
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es un array
  
  Comprueba si la variable es un array.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es un <info>array</info>,  o de lo contrario <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>


id: is_bool
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es de tipo booleano
    
  
  Obtiene si la variable dada es un booleano.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es un <info>boolean</info>, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_callable
type: function
doc:
<comment>Description:</comment>
  Verificar que los contenidos de una variable puedan ser llamados como una
     función
    
  
  Verifica que los contenidos de una variable puedan ser llamados como una función. Esto permite
  revisar que los contenidos de una variable contengan el nombre de una  función válida, o que un
  array contenga un objeto adecuadamente codificado y un nombre de función.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$var</strong>            El valor a revisar
  <info></info>        <strong>$solo_sintaxis</strong>  Si es <info>true</info> la función solo verifica que <strong>$nombre</strong> pueda ser una función o un
                          método. Solo rechazará  variables simples que no sean cadenas, o un array
                          que no tenga una estructura  válida para ser usado como llamada de
                          retorno. Se espera que las matrices válidas  tengan solo 2 entradas, la
                          primera de las cuales es un objeto o una cadena, y la segunda una cadena.
  <info>string</info>  <strong>$callable_name</strong>  Recibe el "nombre que puede ser llamado". En el ejemplo siguiente aquél es
                          "algunaClase:algunMetodo". Tenga en cuenta, sin embargo, que a pesar de la
                          implicación de que algunaClase::algunMetodo() es un método estático que
                          puede ser llamado, este no es el caso.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> puede ser llamado, <info>false</info>  de lo contrario.

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>method_exists()</strong>


id: is_countable
type: function
doc:
<comment>Description:</comment>
  Verifica que el contenido de una variable es un valor contable
    
  
  Verifica que el contenido de una variable es un <info>array</info> o un objeto implementando <class>Countable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  El valor a comprobar

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es contable, <info>false</info>  en caso contrario.

<comment>See Also:</comment>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>
   * <strong>is_iterable()</strong>
   * <strong>is_bool()</strong>


id: is_dir
type: function
doc:
<comment>Description:</comment>
  Indica si el nombre de archivo es un directorio
  
  Indica si el nombre de archivo dado es un directorio.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta al archivo. Si <strong>$filename</strong> es un nombre de archivo relativo, será verificado
                     relativo al directorio de trabajo actual. Si <strong>$filename</strong> es un enlace simbólico o
                     duro, el enlace será resuelto y comprobado. Si tiene activado open_basedir se
                     pueden aplicar más restricciones.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el nombre de archivo existe y es un directorio, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>dir()</strong>
   * <strong>opendir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


id: is_double
type: function
doc:
<comment>Description:</comment>
  Alias de is_float
  
  Esta función es un alias de:  <strong>is_float()</strong>.


id: is_executable
type: function
doc:
<comment>Description:</comment>
  Indica si el nombre de archivo es ejecutable
  
  Indica si el nombre de archivo es ejecutable.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta del archivo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el nombre de archivo existe y es ejecutable, o <info>false</info> si se produjo un
        error.

<comment>See Also:</comment>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


id: is_file
type: function
doc:
<comment>Description:</comment>
  Indica si el nombre de fichero es un fichero normal
  
  Indica si el fichero dado es un fichero normal.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta del fichero.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el nombre de fichero existe y es un fichero normal, <info>false</info> si no.
        
        Debido a que el tipo integer de PHP es con signo y muchas plataformas usan enteros de 32
        bits,
        algunas funciones de sistema de ficheros pueden devolver resultados inesperados para
        ficheros que
        son mayores de 2 GB.

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


id: is_finite
type: function
doc:
<comment>Description:</comment>
  Encuentra si un valor es un número finito legal
  
  Verifica si <strong>$val</strong> es un número finito legal en esta plataforma.

<comment>Param:</comment>
  <info>float</info>  <strong>$val</strong>  El valor a chequear

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si <strong>$val</strong> es un número finito legal en el rango permitido para un valor flotante PHP en
        esta plataforma, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_infinite()</strong>
   * <strong>is_nan()</strong>


id: is_float
type: function
doc:
<comment>Description:</comment>
  Comprueba si el tipo de una variable es float
  
  Comprueba si el tipo de variable dado es float.
  
  Para comprobar si una variable es un número o un string numérico  (por ejemplo, un formulario de
  entrada, que es siempre un string), debe utilizar  <strong>is_numeric()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es de tipo <info>float</info>,  o <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_infinite
type: function
doc:
<comment>Description:</comment>
  Encuentra si un valor es infinito
  
  Devuelve <info>true</info> si <strong>$val</strong> es infinito (positivo o negativo), como el resultado de <return>log(0)</return> o cualquier
  valor demasiado grande para caber en un flotante en esta plataforma.

<comment>Param:</comment>
  <info>float</info>  <strong>$val</strong>  El valor a chequear

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si <strong>$val</strong> es infinito, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_nan()</strong>


id: is_int
type: function
doc:
<comment>Description:</comment>
  Comprueba si el tipo de una variable es integer
  
  Comprueba si el tipo de variable dado es integer.
  
  Para comprobar si una variable es un número o un string numérico  (por ejemplo, un formulario de
  entrada, que es siempre un string), debe utilizar  <strong>is_numeric()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es de tipo <info>integer</info>,  o <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_float()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_integer
type: function
doc:
<comment>Description:</comment>
  Alias de is_int
  
  Esta función es un alias de:  <strong>is_int()</strong>.


id: is_iterable
type: function
doc:
<comment>Description:</comment>
  Verifica que el contenido de una variable es un valor iterable
    
  
  Verifica que el contenido de una variable es aceptado  por el pseudo-tipo <info>iterable</info>, p.e. que es o
  bien un <info>array</info> o un objeto implementando <class>Traversable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  El valor a comprobar

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es iterable, <info>false</info>  en caso contrario.

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


id: is_link
type: function
doc:
<comment>Description:</comment>
  Indica si el nombre de archivo es un enlace simbólico
  
  Indica si el archivo dado es un enlace simbólico.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta del archivo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el nombre de archivo existe y es un enlace simbólico, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>readlink()</strong>


id: is_nan
type: function
doc:
<comment>Description:</comment>
  Encuentra si un valor no es un número
  
  Verifica si <strong>$val</strong> no es un numero,  como por ejemplo el resultado de <return>acos(1.01)</return>.

<comment>Param:</comment>
  <info>float</info>  <strong>$val</strong>  El valor a revisar

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$val</strong> no es un número, en caso contrario devuelve <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_infinite()</strong>


id: is_null
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es null
    
  
  Comprueba si la variable dada es <info>null</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es <info>null</info>, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * El tipo <info>null</info>
   * <strong>isset()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_numeric
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es un número o un string numérico
    
  
  Comprueba si la variable dada es numérica o string numérico.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La variable a evaluar.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es un número o una cadena numérica, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * String numérico
   * <strong>ctype_digit()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_null()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_object
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es un objeto
  
  Comprueba si la variable dada es un objeto.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es un <info>object</info>,  o <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_float()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>


id: is_readable
type: function
doc:
<comment>Description:</comment>
  Indica si un fichero existe y es legible
  
  Indica si un fichero existe y es legible.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta del fichero.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el fichero o directorio especificado por <strong>$filename</strong> existe y es legible,
        <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>is_writable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fgets()</strong>


id: is_resource
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es un recurso
    
  
  Comprueba si la variable es un recurso.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable que se evalúa.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es un <info>resource</info>, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * La documentación del tipo recurso
   * <strong>get_resource_type()</strong>


id: is_scalar
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es escalar
    
  
  Obtiene si la variable dada es escalar.
  
  Las variables escalares son aquellas que contienen un <info>integer</info>,  <info>float</info>, <info>string</info> o <info>boolean</info>.   Tipos
  <info>array</info>, <info>object</info> y <info>resource</info>  no son escalares.
  
  <strong>is_scalar()</strong> no tiene en cuenta <info>resource</info> como escalares ya que los recursos son tipos de datos
  abstractos  que actualmente se basan en enteros. No debe confiar en este detalle de
  implementación, ya que puede cambiar.
  
  <strong>is_scalar()</strong> no considera que NULL sea escalar.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es escalar, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_real()</strong>
   * <strong>is_string()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_soap_fault
type: function
doc:
<comment>Description:</comment>
  Comprueba si una llamada SOAP ha fallado
  
  Esta función es útil para comprobar si la llamada SOAP ha fallado, pero sin usar excepciones. Para
  usarse, cree el objecto <class>SoapClient</class> con la opción <return>exceptions</return> definida a cero o <info>false</info>. En este caso,
  el método SOAP devolverá un objecto especial <class>SoapFault</class> el qual encapsula los datos del fallo
  (faultcode, faultstring, faultactor and faultdetails).
  
  Si <return>exceptions</return> no está definido la llamada SOAP lanzará una excepción al producirse un error.
  <strong>is_soap_fault()</strong> comprueba si un parametro dado es un objecto <class>SoapFault</class>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$object</strong>  El objecto a comprobar.

<comment>Return:</comment>
  <info>bool</info>  Devolverá <info>true</info> si se produce un error y <info>false</info> en caso contrario.

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


id: is_string
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable es de tipo string
  
  Obtiene si la variable dada es de tipo string.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> es de tipo <info>string</info>, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_subclass_of
type: function
doc:
<comment>Description:</comment>
  Comprueba si el objeto tiene esta clase como uno de sus padres o si la implementa
  
  Comprueba si el <strong>$object</strong> dado tiene la clase <strong>$class_name</strong> como uno de sus padres o si la implementa.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object</strong>        Un nombre de clase o una instancia de objeto. No se genera ningún error si
                         la clase no existe.
  <info>string</info>  <strong>$class_name</strong>    El nombre de clase
  <info>bool</info>    <strong>$allow_string</strong>  Si se define este parámetro como false, no se permite el uso del nombre de
                         la clase como <strong>$object</strong>. Esto también previene llamar el autoloader si la
                         clase no existe.

<comment>Return:</comment>
  <info>bool</info>  Esta función devuelve <info>true</info> si el objeto <strong>$object</strong> pertenece a una clase que sea subclase de
        <strong>$class_name</strong>, <info>false</info> en caso contrario.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_a()</strong>
   * <strong>class_parents()</strong>


id: is_tainted
type: function
doc:
<comment>Description:</comment>
  Comprobar si un string está corrompido
  
  Comprueba si un string está corrompido

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve TRUE si el string está corrompido, FALSE en caso contrario.


id: is_uploaded_file
type: function
doc:
<comment>Description:</comment>
  Indica si el archivo fue subido mediante HTTP POST
  
  Devuelve <info>true</info> si el archivo nombrado por <strong>$filename</strong> fue subido mediante HTTP POST. Esto es útil
  para intentar asegurarse de que un usuario malicioso no ha intentado engañar al script haciéndole
  trabajar con archivos con los que no debiera de estar trabajando--por ejemplo, /etc/passwd.
  
  Este tipo de comprobación es especialmente importante si hay alguna posibilidad de que nada hecho
  con los archivos subidos pueda revelar su contenido al usuario, o incluso a otros usuarios en el
  mismo sistema.
  
  Para un funcionamiento apropiado, la función <strong>is_uploaded_file()</strong> necesita un argumento como
  $_FILES['archivo_usuario']['tmp_name'], - el nombre del archivo subido de la máquina del cliente
  $_FILES['archivo_usuario']['name'] no funciona.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El nombre de archivo que se va a comprobar.

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

<comment>See Also:</comment>
   * <strong>move_uploaded_file()</strong>
   * $_FILES
   * Véase Manejo de subidas de archivos para
    un sencillo ejemplo de uso.


id: is_writable
type: function
doc:
<comment>Description:</comment>
  Indica si un archivo existe y es escribible
  
  Devuelve <info>true</info> si <strong>$filename</strong> existe y es escribible. El argumento nombre_archivo puede ser el nombre
  de un directorio, permitiendo así comprobar si el directorio es escribible.
  
  Tenga en cuenta que PHP puede estar accediendo al archivo bajo el id de ususario por el que se
  está ejecutando el servidor web (a menudo 'nobody'). Las limitaciones del modo seguro no se toman
  en cuenta.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El nombre de archivo que va a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el parámetro <strong>$filename</strong> existe y es escribible.

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fwrite()</strong>


id: is_writeable
type: function
doc:
<comment>Description:</comment>
  Alias de is_writable
  
  Esta función es un alias de:  <strong>is_writable()</strong>.


id: isset
type: function
doc:
<comment>Description:</comment>
  Determina si una variable está definida y no es null
  
  Determina si una variable está definida y no es <info>null</info>.
  
  Si una variable ha sido removida con <strong>unset()</strong>, esta ya no estará definida. <strong>isset()</strong> devolverá <info>false</info>
  si prueba una variable que ha sido definida como <info>null</info>. También tenga en cuenta que un byte <info>null</info>
  (<return>"\0"</return>) no es equivalente a la constante <info>null</info> de PHP.
  
  Si son pasados varios parámetros, entonces <strong>isset()</strong> devolverá <info>true</info> únicamente si todos los
  parámetros están definidos. La evaluación se realiza de izquierda a derecha y se detiene tan
  pronto como se encuentre una variable no definida.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable a ser evaluada.
  <info>mixed</info>  <strong>$...</strong>  Otra variable...

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$var</strong> existe y tiene un valor distinto de <info>null</info>, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>empty()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>defined()</strong>
   * las tablas de comparación de tipos
   * <strong>array_key_exists()</strong>
   * <strong>is_null()</strong>
   * el operador @ de control de errores


id: iterator_apply
type: function
doc:
<comment>Description:</comment>
  Llamar a una función para cada elemento de un iterador
  
  Llama a una función para cada elemento de un iterador.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  La clase a recorrer.
  <info>callable</info>     <strong>$function</strong>  La función de llamada de retorno a invocar para cada elemento.  Esta
                          función debe retornar <info>true</info> para continuar recorriendo el <strong>$iterator</strong>.
                          
                          Esta función debe retornar <info>true</info> para continuar recorriendo el <strong>$iterator</strong>.
  <info>array</info>        <strong>$args</strong>      Argumentos a pasar a la función de llamada de retorno.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de iteraciones.

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


id: iterator_count
type: function
doc:
<comment>Description:</comment>
  Contar los elementos de un iterador
  
  Contar los elementos de un iterador. <strong>iterator_count()</strong> no garantiza conservar la posición actual de
  <strong>$iterator</strong>.

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

<comment>Return:</comment>
  <info>int</info>  El número de elementos de <strong>$iterator</strong>.


id: iterator_to_array
type: function
doc:
<comment>Description:</comment>
  Copiar el iterador a un array
  
  Copia los elementos de un iterador a un array.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  El iterador a copiar.
  <info>bool</info>         <strong>$use_keys</strong>  Si usar las claves del elemento iterador como índice.
                          
                          En PHP 5.5 y posterior, si una clave es un <info>array</info> u <info>object</info>, se generará una
                          advertencia. Las claves <info>null</info> serán convertidas a un string vacío, las
                          claves <info>float</info> serán truncadas a su equivalente <info>integer</info>, las claves <info>resource</info>
                          generarán una advertencia y serán convertidas a sus ID de recurso, y las
                          claves <info>boolean</info> serán convertidas a enteros.
                          
                          Si no se establece este parámetro o se establece a <info>true</info>, las claves
                          duplicadas serán sobrescritas. El último valor con una clave dada estará
                          en el <info>array</info> devuelto. Para obtener todos los valores en cualquier caso, se
                          ha de establecer este parámetro a <info>false</info>.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contiene los elementos del <strong>$iterator</strong>.


id: jddayofweek
type: function
doc:
<comment>Description:</comment>
  Devuelve el día de la semana
  
  Devuelve el día de la semana. Puede devolver una cadena o un entero dependiendo del modo.

<comment>Param:</comment>
  <info>int</info>  <strong>$julianday</strong>  Un número de día juliano como un entero
  <info>int</info>  <strong>$mode</strong>       

<comment>Return:</comment>
  <info>mixed</info>  El día de la semada gregoriana como un entero o cadena.


id: jdmonthname
type: function
doc:
<comment>Description:</comment>
  Devuelve el nombre de un mes
  
  Devuelve una cadena que contiene el nombre del mes. <strong>$mode</strong> le indica a esta función a qué
  calendario va a ser convertido la Fecha Juliana, y qué tipo de nombres de meses son devueltos.
  Calendar modesModoSignificadoValores0Gregoriano - abreviadoJan, Feb, Mar, Apr, May, Jun, Jul, Aug,
  Sep, Oct, Nov, Dec1GregorianoJanuary, February, March, April, May, June, July, August, September,
  October, November, December2Juliano - abreviadoJan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
  Nov, Dec3JulianoJanuary, February, March, April, May, June, July, August, September, October,
  November, December4JudíoTishri, Heshvan, Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar,
  Sivan, Tammuz, Av, Elul5Republicano FrancésVendemiaire, Brumaire, Frimaire, Nivose, Pluviose,
  Ventose, Germinal, Floreal, Prairial, Messidor, Thermidor, Fructidor, Extra

<comment>Param:</comment>
  <info></info>  <strong>$jday</strong>      La Fecha Juliana que se va a manejar
  <info></info>  <strong>$calendar</strong>  El calendario del que se va a tomar el nombre del mes

<comment>Return:</comment>
  <info>string</info>  El nombre del mes de la Fecha Juliana y del calendario <strong>$calendar</strong> dados.


id: jdtofrench
type: function
doc:
<comment>Description:</comment>
  Convierte una Fecha Juliana al Calendario Republicano Francés
  
  Convierte una Fecha Juliana al Calendario Republicano Francés.

<comment>Param:</comment>
  <info></info>  <strong>$julianday</strong>  Una número de día juliano como un entero

<comment>Return:</comment>
  <info>string</info>  La fecha de la Revolución Francesa como una cadena de la forma "mes/día/año"

<comment>See Also:</comment>
   * <strong>frenchtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtogregorian
type: function
doc:
<comment>Description:</comment>
  Convierte una Fecha Juliana en una fecha Gregoriana
  
  Convierte una Fecha Juliana a una cadena que contiene la fecha Gregoriana con el formato
  "mes/día/año".

<comment>Param:</comment>
  <info>int</info>  <strong>$julianday</strong>  Un número de día juliano como un entero

<comment>Return:</comment>
  <info>string</info>  La fecha gregoriana como una cadena de la forma "mes/día/año"

<comment>See Also:</comment>
   * <strong>gregoriantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojewish
type: function
doc:
<comment>Description:</comment>
  Convierte una Fecha Juliana a una fecha del Calendario Judío
  
  Convierte una Fecha Juliana al Calendario Judío.

<comment>Param:</comment>
  <info></info>      <strong>$julianday</strong>  Un número de día juliano como un entero
  <info>bool</info>  <strong>$hebrew</strong>     Si el parámetro <strong>$hebrew</strong> está establecido a <info>true</info>, el parámetro <strong>$fl</strong> se usa para el
                    formato de salida, basado en cadena, Hebreo.
  <info>int</info>   <strong>$fl</strong>         Los formatos disponibles son: <info>CAL_JEWISH_ADD_ALAFIM_GERESH</info>,
                    <info>CAL_JEWISH_ADD_ALAFIM</info>, <info>CAL_JEWISH_ADD_GERESHAYIM</info>.

<comment>Return:</comment>
  <info>string</info>  La fecha judía como una cadena de la forma "mes/día/año"

<comment>See Also:</comment>
   * <strong>jewishtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojulian
type: function
doc:
<comment>Description:</comment>
  Convierte una Fecha Juliana a una fecha del Calendario Juliano
  
  Convierte una Fecha Juliana a una cadena que contiene la fecha del Calendario Juliano con el
  formato "mes/día/año".

<comment>Param:</comment>
  <info>int</info>  <strong>$julianday</strong>  Un número de día juliano como un entero

<comment>Return:</comment>
  <info>string</info>  La fecha del calendario juliano como una cadena de la forma "mes/día/año"

<comment>See Also:</comment>
   * <strong>juliantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtounix
type: function
doc:
<comment>Description:</comment>
  Convierte una Fecha Juliana a una fecha Unix
  
  Esta funcion devolverá una fecha Unix correspondiente a la Fecha Juliana dada en <strong>$jday</strong> o <info>false</info> si
  <strong>$jday</strong> no está dentro de la época Unix (años gregorianos entre 1970 y 2037 o 2440588 \<= <strong>$jday</strong> \<= 2465342 ). El momento devuleto es como hora local (y no GMT).

<comment>Param:</comment>
  <info>int</info>  <strong>$jday</strong>  Un número de día juliano entre 2440588 y 2465342.

<comment>Return:</comment>
  <info>int</info>  La fecha Unix para el comienzo de la Fecha Juliana dada.

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


id: jewishtojd
type: function
doc:
<comment>Description:</comment>
  Convierte una fecha del Calendario Judío a una Fecha Juliana
  
  Aunque esta función puede manejar fechas que se remontan hasta el año 1 (3761 A.C.), tal uso puede
  no ser significativo. El calendario judío ha estado en uso desde varios cientos de años, pero en
  los primeros días no había una fórmula para determinar el inicio del un mes. Un nuevo mes
  comenzaba cuando se observaba la primera luna nueva.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  El mes como un número de 1 a 13
  <info>int</info>  <strong>$day</strong>    El día como un número de 1 a 30
  <info>int</info>  <strong>$year</strong>   El año como un número entre 1 y 9999

<comment>Return:</comment>
  <info>int</info>  La Fecha Juliana para la fecha judía dada como un entero.

<comment>See Also:</comment>
   * <strong>jdtojewish()</strong>
   * <strong>cal_to_jd()</strong>


id: join
type: function
doc:
<comment>Description:</comment>
  Alias de implode
  
  Esta función es un alias de:  <strong>implode()</strong>.


id: jpeg2wbmp
type: function
doc:
<comment>Description:</comment>
  Convertir un archiov de imagen JPEG a un archivo de imagen WBMP
  
  Convierte un archivo JPEG en un archivo WBMP.

<comment>Param:</comment>
  <info>string</info>  <strong>$jpegname</strong>     Ruta del archivo JPEG.
  <info>string</info>  <strong>$wbmpname</strong>     Ruta del archivo WBMP de destino.
  <info>int</info>     <strong>$dest_height</strong>  Alto de la imagen de destino.
  <info>int</info>     <strong>$dest_width</strong>   Ancho de la imagen de destino.
  <info>int</info>     <strong>$threshold</strong>    Valor de umbral, entre 0 y 8 (inclusive).

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


id: json_decode
type: function
doc:
<comment>Description:</comment>
  Decodifica un string de JSON
  
  Convierte un string codificado en JSON a una variable de PHP.

<comment>Param:</comment>
  <info>string</info>     <strong>$json</strong>         El <info>string</info> de <strong>$json</strong> a decodificar.
                           
                           Esta función sólo trabaja con string codificados en UTF-8.
                           
                           PHP implementa un superconjunto de JSON tal como se especifica en la RFC
                           7159 original.
  <info>bool|null</info>  <strong>$associative</strong>  Cuando es <info>true</info>, los objects JSON devueltos serán convertidos a <info>array</info>
                           asociativos, cuando es <info>false</info> los objects JSON devueltos serán convertidos
                           a <info>object</info>s. Cuando es <info>null</info>, los objects JSON serán convertidos a <info>array</info>
                           asociativos u <info>object</info>s  dependiendo de si <info>JSON_OBJECT_AS_ARRAY</info> es
                           establecida en los <strong>$flags</strong>
  <info>int</info>        <strong>$depth</strong>        Profundidad máxima de anidamiento de la estructura que se decodifica.
  <info>int</info>        <strong>$flags</strong>        Máscara de bit de <info>JSON_BIGINT_AS_STRING</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                           <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_OBJECT_AS_ARRAY</info>, <info>JSON_THROW_ON_ERROR</info>.
                           El comportamiento de estas constantes está descrito en la pagina de  JSON
                           constants.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor codificado en <strong>$json</strong> en un tipo de PHP apropiado. Los valores <return>true</return>, <return>false</return>
         y <return>null</return> son devueltos como <info>true</info>, <info>false</info> y <info>null</info> respectivamente. <info>null</info> es devuelto si el
         parámetro <strong>$json</strong> no se puede decodificar o si los datos codificados son más profundos que el
         límite de recursividad.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_last_error()</strong>


id: json_encode
type: function
doc:
<comment>Description:</comment>
  Retorna la representación JSON del valor dado
  
  Devuelve un string con la representación JSON de <strong>$value</strong>.
  
  La codificación se ve afectada por los <strong>$flags</strong> suministrados y además la codificación de los
  valores de tipo float dependen del valor de serialize_precision.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El <strong>$value</strong> a ser codificado. Puede ser de cualquier tipo menos un <info>resource</info>.
                 
                 Todos los datos de tipo string deben estar codificados con UTF-8.
                 
                 PHP implementa un superconjunto de JSON tal como se especifica en la RFC 7159
                 original.
  <info>int</info>    <strong>$flags</strong>  Máscara de bits que compuesta por <info>JSON_FORCE_OBJECT</info>, <info>JSON_HEX_QUOT</info>, <info>JSON_HEX_TAG</info>,
                 <info>JSON_HEX_AMP</info>, <info>JSON_HEX_APOS</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                 <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_NUMERIC_CHECK</info>, <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>,
                 <info>JSON_PRESERVE_ZERO_FRACTION</info>, <info>JSON_PRETTY_PRINT</info>, <info>JSON_UNESCAPED_LINE_TERMINATORS</info>,
                 <info>JSON_UNESCAPED_SLASHES</info>, <info>JSON_UNESCAPED_UNICODE</info>, <info>JSON_THROW_ON_ERROR</info>. El
                 comportamiento de estas constantes se describe en la página de constantes de JSON.
  <info>int</info>    <strong>$depth</strong>  Establece la profundidad máxima. Debe ser mayor que cero.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve un <info>string</info> JSON codificado en caso de éxito  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * JsonSerializable
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>serialize()</strong>


id: json_last_error
type: function
doc:
<comment>Description:</comment>
  Devuelve el último error ocurrido
  
  Devuelve el último error (si existe) que ocurrió durante la última codificación/decodificación
  JSON.

<comment>Return:</comment>
  <info>int</info>  Devuelve un integer, que puede ser una de las siguientes constantes:

<comment>See Also:</comment>
   * <strong>json_last_error_msg()</strong>
   * <strong>json_decode()</strong>
   * <strong>json_encode()</strong>


id: json_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Devuelve el string con el error de la última llamada a json_encode() o a json_decode()

<comment>Return:</comment>
  <info>string</info>  Devuelve el mensaje de error en caso de éxito, <return>"No Error"</return> si no ocurrió ningún error,  o
          <info>false</info> en caso de error.

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


id: json_validate
type: function
doc:
<comment>Description:</comment>
  Checks if a string contains valid JSON
  
  Returns whether the given <info>string</info> is syntactically valid JSON. If <strong>json_validate()</strong> returns <info>true</info>,
  <strong>json_decode()</strong> will successfully decode the given string when using the same <strong>$depth</strong> and <strong>$flags</strong>.
  
  If <strong>json_validate()</strong> returns <info>false</info>, the cause can be retrieved using <strong>json_last_error()</strong> and
  <strong>json_last_error_msg()</strong>.
  
  <strong>json_validate()</strong> uses less memory than <strong>json_decode()</strong> if the decoded JSON payload is not used,
  because it does not need to build the array or object structure containing the payload.
  
  Calling <strong>json_validate()</strong> immediately before <strong>json_decode()</strong> will unnecessarily parse the string
  twice, as <strong>json_decode()</strong> implicitly performs validation during decoding.
  
  <strong>json_validate()</strong> should therefore only be used if the decode JSON payload is not immediately used
  and knowing whether the string contains valid JSON is needed.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>   The string to validate.
                  
                  This function only works with UTF-8 encoded strings.
                  
                  PHP implementa un superconjunto de JSON tal como se especifica en la RFC 7159
                  original.
  <info>int</info>     <strong>$depth</strong>  Maximum nesting depth of the structure being decoded. The value must be greater
                  than <return>0</return>, and less than or equal to <return>2147483647</return>.
  <info>int</info>     <strong>$flags</strong>  Currently only <info>JSON_INVALID_UTF8_IGNORE</info> is accepted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the given string is syntactically valid JSON, otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>json_last_error_msg()</strong>


id: juliantojd
type: function
doc:
<comment>Description:</comment>
  Convierte una fecha del Calendario Juliano a una Fecha Juliana
  
  El rango válido para el Calendario Juliano es desde 4713 A.C. a 9999 D.C.
  
  Aunque esta función puede manejar fechas que se remontan hasta 4713 A.C., tal uso puede no ser
  significativo. El calendario fue creado en el 46 A.C., pero los detalles no se estabilizaron hasta
  al menos el 8 D.C., y quizás hasta el siglo IV tardío. También, el comienzo de un año variaba de
  una cultura a otra - no todas aceptaron enero como el primer mes.
  
  Recuerde, el sistema de calendario actual que se usa mundialmente es el Calendario Gregoriano.
  <strong>gregoriantojd()</strong> se puede usar para convertir tales fechas a sus Fechas Julianas.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  El mes como un número de 1 (para enero) a 12 (para diecienbre)
  <info>int</info>  <strong>$day</strong>    El día como un número de 1 a 31
  <info>int</info>  <strong>$year</strong>   El año como un número entre -4713 y 9999

<comment>Return:</comment>
  <info>int</info>  La Fecha Juliana para la fecha del Calendario Juliano dado como un entero.

<comment>See Also:</comment>
   * <strong>jdtojulian()</strong>
   * <strong>cal_to_jd()</strong>


id: key
type: function
doc:
<comment>Description:</comment>
  Obtiene una clave de un array
  
  <strong>key()</strong> devuelve el elemento índice de la posición actual del array.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  El array.

<comment>Return:</comment>
  <info>mixed</info>  La función <strong>key()</strong> simplemente devuelve la clave del elemento del array que está apuntando
         actualmente el puntero interno. No desplaza el puntero de ninguna manera. Si el puntero
         interno señala más allá del final de la lista de elementos o el array está vacío, <strong>key()</strong>
         devuelve <info>null</info>.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>next()</strong>
   * foreach


id: key_exists
type: function
doc:
<comment>Description:</comment>
  Alias de array_key_exists
  
  Esta función es un alias de:  <strong>array_key_exists()</strong>.


id: krsort
type: function
doc:
<comment>Description:</comment>
  Ordena un array por clave en orden inverso
  
  Ordena un array por clave en orden inverso, manteniendo la correlación entre la clave y los datos.
  Esto es útil principalmente para arrays asociativos.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>       El array de entrada.
  <info>int</info>    <strong>$sort_flags</strong>  Se puede modificar el comportamiento del ordenado usando el parámetro opcional
                      <strong>$sort_flags</strong>, par más información vea <strong>sort()</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>arsort()</strong>
   * <strong>ksort()</strong>
   * comparación de funciones de orden de arrays


id: ksort
type: function
doc:
<comment>Description:</comment>
  Ordena un array por clave
  
  Ordena un array por clave, manteniendo la correlación entre la clave y los datos. Esto es útil
  principalmente para arrays asociativos.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>       El array de entrada.
  <info>int</info>    <strong>$sort_flags</strong>  Se puede modificar el comportamiento del ordenado usando el parámetro opcional
                      <strong>$sort_flags</strong>, par más información vea <strong>sort()</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>asort()</strong>
   * comparación de funciones de orden de arrays


id: lcfirst
type: function
doc:
<comment>Description:</comment>
  Pasa a minúscula el primer caracter de un string
  
  Devuelve un string con el primer caracter de <strong>$str</strong> en minúscula si ese caracter es alfabético.
  
  Tener en cuenta que 'alfabético' está determinado por la configuración regional actual. Por
  ejemplo, en la configuración regional por defecto "C" caracteres como la a con diéresis (ä) no
  serán convertidos.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  El string de entrada.

<comment>Return:</comment>
  <info>string</info>  Devuelve el string resultante.

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


id: lcg_value
type: function
doc:
<comment>Description:</comment>
  Combined linear congruential generator
  
  <strong>lcg_value()</strong> returns a pseudo random number in the range of (0, 1).  The function combines two CGs
  with periods of 2^31 - 85 and 2^31 - 249. The period of this function is equal to the product of
  both primes.
  
  Esta función no
  genera valores criptográficos fiables por lo que no debería empelarse para propósitos
  criptográficos. Si fuera necesario
  un valor criptográfico seguro, considérese utilizar <strong>random_int()</strong>, <strong>random_bytes()</strong>, o
  <strong>openssl_random_pseudo_bytes()</strong> en su lugar.
  
  Scaling the return value to a different interval using multiplication or addition (a so-called
  affine transformation) might result in a bias in the resulting value as floats are not equally
  dense across the number line. As not all values can be exactly represented by a float, the result
  of the affine transformation might also result in values outside of the requested interval.
  
  Use Random\Randomizer::getFloat to generate a random float within an arbitrary interval. Use
  Random\Randomizer::getInt to generate a random integer within an arbitrary interval.

<comment>Return:</comment>
  <info>float</info>  A pseudo random float value between 0.0 and 1.0, inclusive.

<comment>See Also:</comment>
   * Random\Randomizer::getFloat
   * Random\Randomizer::getInt
   * <strong>random_int()</strong>


id: lchgrp
type: function
doc:
<comment>Description:</comment>
  Cambia el grupo de un enlace simbólico
  
  Intenta cambiar el grupo del enlace simbólico <strong>$filename</strong> a <strong>$group</strong>.
  
  Sólo el superusuario puede cambiar el grupo de un enlace simbólico; otros usuarios pueden cambiar
  el grupo de un enlace simbólico a cualquier grupo de cual ese usuario es miembro.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta del enlace simbólico.
  <info>mixed</info>   <strong>$group</strong>     El grupo especificado por un nombre o un número.

<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>chgrp()</strong>
   * <strong>lchown()</strong>
   * <strong>chown()</strong>
   * <strong>chmod()</strong>


id: lchown
type: function
doc:
<comment>Description:</comment>
  Cambia el propietario de un enlace simbólico
  
  Intenta cambiar el propietario del enlace simbólico <strong>$filename</strong> al usuario <strong>$user</strong>.
  
  Sólo el superusuario puede cambiar el propietario de un enlace simbólico.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta al archivo.
  <info>mixed</info>   <strong>$user</strong>      Nómbre o número de usuario.

<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>chown()</strong>
   * <strong>lchgrp()</strong>
   * <strong>chgrp()</strong>
   * <strong>chmod()</strong>


id: ldap_8859_to_t61
type: function
doc:
<comment>Description:</comment>
  Traducir caracteres 8859 a caracteres t61
  
  Traducir caracteres <return>ISO-8859</return> a caracteres <return>t61</return>.
  
  Esta función es útil si tienes que hablarle a un legado de servidor <return>LDAPv2</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El texto a ser traducido.

<comment>Return:</comment>
  <info>string</info>  Devuelve la traducción <return>t61</return> de el <strong>$value</strong>.

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


id: ldap_add
type: function
doc:
<comment>Description:</comment>
  Agregar entradas al directorio de LDAP
  
  Agregar entradas en el directorio de LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>array</info>     <strong>$entry</strong>            Un array que especifica la información acerca de la entrada. Los
                              valores en las entradas están indexados por atributos individuales. En
                              el caso de valores múltiples para un atributo, estos se indexan
                              utilizando números enteros comenzando desde 0.  ]]>

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


id: ldap_add_ext
type: function
doc:
<comment>Description:</comment>
  Add entries to LDAP directory
  
  Does the same thing as <strong>ldap_add()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_bind
type: function
doc:
<comment>Description:</comment>
  Realiza la autenticación con un servidor LDAP
  
  Autentica contra un servidor LDAP tomando un RDN y contraseña especificados.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  El identificador de enlace LDAP, devuelto por la función
                              <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$bind_rdn</strong>         
  <info>string</info>    <strong>$bind_password</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>ldap_unbind()</strong>


id: ldap_bind_ext
type: function
doc:
<comment>Description:</comment>
  Bind to LDAP directory
  
  Does the same thing as <strong>ldap_bind()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_bind()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_close
type: function
doc:
<comment>Description:</comment>
  Alias de ldap_unbind
  
  Esta función es un alias de:  <strong>ldap_unbind()</strong>.


id: ldap_compare
type: function
doc:
<comment>Description:</comment>
  Comparar el valor del atributo encontrado en la entrada que se especificó con un DN
  
  Comparar el <strong>$value</strong> del <strong>$attribute</strong> con el valor del mismo atributo en una entrada del directorio de
  LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>string</info>    <strong>$attribute</strong>        El nombre del atributo.
  <info>string</info>    <strong>$value</strong>            El valor comparado.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> si <strong>$value</strong> es similar de otra forma devuelve <info>false</info>. Devuelve -1 en caso de
         error.


id: ldap_connect
type: function
doc:
<comment>Description:</comment>
  Abre una conexión a un servidor LDAP
  
  Establece una conexión con un servidor LDAP en un determinado  <strong>$hostname</strong> and <strong>$port</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Si se está usando OpenLDAP 2.x.x se puede especificar una URL en lugar del
                     host. Para usar LDAP con SSL, se debe compilar OpenLDAP 2.x.x  con soporte para
                     SSL, configurar PHP con SSL y colocar este parámetro como <return>ldaps://hostname/</return>.
  <info>int</info>     <strong>$port</strong>      El puerto al cual debe conectarse. No se usa cuando se está usando URLs.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador de enlace al LDAP en caso de éxito o <info>false</info> en  caso de error.
            Cuando se está usando OpenLDAP 2.x.x, <strong>ldap_connect()</strong>  devolverá siempre un <info>resource</info> que
            no es la conexión en sí sino solo inicialización de los parámetros de conexión. La
            conexión real se realizará en la siguiente llamada a las funciones ldap_*, por lo
            general <strong>ldap_bind()</strong>.
            
            Si no se especificaron parámetros, será retornado el identificador de enlace  de la
            conexión activa.

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


id: ldap_connect_wallet
type: function
doc:
<comment>Description:</comment>
  Connect to an LDAP server
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>        
  <info>string</info>       <strong>$wallet</strong>     
  <info>string</info>       <strong>$password</strong>   
  <info>int</info>          <strong>$auth_mode</strong>  

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  

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


id: ldap_control_paged_result
type: function
doc:
<comment>Description:</comment>
  Enviar el control de paginación LDAP
  
  Activa la paginación LDAP enviando el control de paginación (tamaño de página, cookie...).

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Un identificador de enlace LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>int</info>       <strong>$pagesize</strong>    El número de entradas por página.
  <info>bool</info>      <strong>$iscritical</strong>  Indica si la paginación es crítica o no.  Si es crítica y el servidor no
                         soporta paginación, la búsqueda no devolverá ningún resultado.
  <info>string</info>    <strong>$cookie</strong>      Una estructura opaca enviada por el servidor
                         (<strong>ldap_control_paged_result_response()</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>ldap_control_paged_result_response()</strong>
   * RFC2696 : Extensión de Control LDAP para la Manipulación
     Simple de Resultados Paginados


id: ldap_control_paged_result_response
type: function
doc:
<comment>Description:</comment>
  Recuperar la cookie de paginación LDAP
  
  Recuperar la información de paginación enviada por el servidor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>       Un identificador de enlace LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result</strong>     
  <info>string</info>    <strong>$cookie</strong>     Una estructura opaca enviada por el servidor.
  <info>int</info>       <strong>$estimated</strong>  El número estimado de entradas a recuperar.

<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>ldap_control_paged_result()</strong>
   * RFC2696 : Extensión de Control LDAP para la
     Manipulación Simple de Resultados Paginados


id: ldap_count_entries
type: function
doc:
<comment>Description:</comment>
  Contar el número de entradas en una búsqueda
  
  Devuelve el número de entradas almacenadas en el resultado de previas operaciones de búsqueda.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>    Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_identifier</strong>  El resultado interno de LDAP.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de entradas en el resultado o <info>false</info> en caso de error.


id: ldap_count_references
type: function
doc:
<comment>Description:</comment>
  Counts the number of references in a search result
  
  Counts the number of references in a search result.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>  An <class>LDAP\Result</class> instance, returned by <strong>ldap_list()</strong> or <strong>ldap_search()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the number of references in a search result.

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


id: ldap_delete
type: function
doc:
<comment>Description:</comment>
  Eliminar una entrada de un directorio
  
  Elimina una entrada en particular en un directorio de LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.

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


id: ldap_delete_ext
type: function
doc:
<comment>Description:</comment>
  Delete an entry from a directory
  
  Does the same thing as <strong>ldap_delete()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_delete()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_dn2ufn
type: function
doc:
<comment>Description:</comment>
  Convertir un DN a un formato de nombramiento amigable al usuario
  
  Convierte un <strong>$dn</strong> específico, a un formato más amigable al usuario, mostrando los tipos de nombre.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>  El nombre distinguido de una entidad de LDAP.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre amigable al usuario.


id: ldap_err2str
type: function
doc:
<comment>Description:</comment>
  Convertir un número de error de LDAP a una cadena con un mensaje de error
  
  Devuelve una cadena con un mensaje de error explicando el número de error de <strong>$errno</strong>. Mientras que
  los números errno de LDAP están estandarizados, diferentes bibliotecas devuelven aún mensajes de
  error textuales localizados. Nunca busque un texto con un mensaje de error específico, pero
  siempre busque un número de error que revisar.

<comment>Param:</comment>
  <info>int</info>  <strong>$errno</strong>  El número de error.

<comment>Return:</comment>
  <info>string</info>  Devuelve el mensaje de error como una cadena.

<comment>See Also:</comment>
   * <strong>ldap_errno()</strong>
   * <strong>ldap_error()</strong>


id: ldap_errno
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de error LDAP del último comando LDAP
  
  Devuelve el número de error estándar devuelto por el último comando LDAP. Este número se puede
  convertir a un mensaje de error textual utilizando <strong>ldap_err2str()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devolver el número de error de LDAP del último comando LDAP para este enlace.

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_error()</strong>


id: ldap_error
type: function
doc:
<comment>Description:</comment>
  Devuelve el mensaje de error de LDAP del último comando LDAP
  
  Devuelve la cadena de mensaje de error que explica el error generado por el último comando LDAP
  para el <strong>$link_identifier</strong> proporcionado. Mientras que los números errno de LDAP están
  estandarizados, distintas bibliotecas devuelven aún mensajes de error textuales localizados. Nunca
  busque un texto con un mensaje de error específico, pero siempre busque un número de error que
  revisar.
  
  A menos que reduzca suficientemente el nivel de advertencias en su php.ini o anteponga a sus
  comandos LDAP con el caracter <return>@</return> (arroba) para suprimir la salida de advertencia, los errores
  generados también se mostrarán en la salida HTML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena de mensaje de error.

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_errno()</strong>


id: ldap_escape
type: function
doc:
<comment>Description:</comment>
  Escapa una cadena de texto para su uso en un filtro LDAP o DN
  
  Escapa <strong>$value</strong> para su uso en el contexto implicado por  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>   El valor a escapar.
  <info>string</info>  <strong>$ignore</strong>  Caracteres a ignorar en el escapado.
  <info>int</info>     <strong>$flags</strong>   El contexto la cadena escapado se utilizará en: <info>LDAP_ESCAPE_FILTER</info> para filtros
                   para ser utilizado con <strong>ldap_search()</strong>, o <info>LDAP_ESCAPE_DN</info> para DNs.

<comment>Return:</comment>
  <info>string</info>  Retorna la cadena escapada.


id: ldap_exop
type: function
doc:
<comment>Description:</comment>
  Performs an extended operation
  
  Performs an extended operation on the specified <strong>$ldap</strong> with <strong>$request_oid</strong> the OID of the operation
  and <strong>$request_data</strong> the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$request_oid</strong>    The extended operation request OID. You may use one of
                                   <info>LDAP_EXOP_START_TLS</info>, <info>LDAP_EXOP_MODIFY_PASSWD</info>, <info>LDAP_EXOP_REFRESH</info>,
                                   <info>LDAP_EXOP_WHO_AM_I</info>, <info>LDAP_EXOP_TURN</info>, or a string with the OID of
                                   the operation you want to send.
  <info>string</info>           <strong>$request_data</strong>   The extended operation request data. May be NULL for some
                                   operations like <info>LDAP_EXOP_WHO_AM_I</info>, may also need to be BER
                                   encoded.
  <info>array</info>            <strong>$controls</strong>       Array of LDAP Controls to send with the request.
  <info>string</info>           <strong>$response_data</strong>  Will be filled with the extended operation response data if
                                   provided. If not provided you may use ldap_parse_exop on the
                                   result object later to get this data.
  <info>string</info>           <strong>$response_oid</strong>   Will be filled with the response OID if provided, usually equal
                                   to the request OID.

<comment>Return:</comment>
  <info>mixed</info>  When used with <strong>$response_data</strong>, returns <info>true</info> on success or <info>false</info> on error. When used without
         <strong>$response_data</strong>, returns a result identifier or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ldap_parse_result()</strong>
   * <strong>ldap_parse_exop()</strong>
   * <strong>ldap_exop_whoami()</strong>
   * <strong>ldap_exop_refresh()</strong>
   * <strong>ldap_exop_passwd()</strong>


id: ldap_exop_passwd
type: function
doc:
<comment>Description:</comment>
  PASSWD extended operation helper
  
  Performs a PASSWD extended operation.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>          An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$user</strong>          dn of the user to change the password of.
  <info>string</info>           <strong>$old_password</strong>  The old password of this user. May be ommited depending of server
                                  configuration.
  <info>string</info>           <strong>$new_password</strong>  The new password for this user. May be omitted or empty to have a
                                  generated password.
  <info>array</info>            <strong>$controls</strong>      If provided, a password policy request control is send with the
                                  request and this is filled with an array of LDAP Controls returned
                                  with the request.

<comment>Return:</comment>
  <info>string|bool</info>  Returns the generated password if <strong>$new_password</strong> is empty or omitted. Otherwise
               returns <info>true</info> on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>ldap_exop()</strong>
   * <strong>ldap_parse_exop()</strong>


id: ldap_exop_refresh
type: function
doc:
<comment>Description:</comment>
  Refresh extended operation helper
  
  Performs a Refresh extended operation and returns the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>    dn of the entry to refresh.
  <info>int</info>              <strong>$ttl</strong>   Time in seconds (between 1 and 31557600) that the client requests that the
                          entry exists in the directory before being automatically removed.

<comment>Return:</comment>
  <info>int|false</info>  From RFC: The responseTtl field is the time in seconds which the server chooses to have
             as the time-to-live field for that entry.  It must not be any smaller than that which
             the client requested, and it may be larger. However, to allow servers to maintain a
             relatively accurate directory, and to prevent clients from abusing the dynamic
             extensions, servers are permitted to shorten a client-requested time-to-live value,
             down to a minimum of 86400 seconds (one day).
              <info>false</info> will be returned on error.

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


id: ldap_exop_sync
type: function
doc:
<comment>Description:</comment>
  Performs an extended operation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$request_oid</strong>    
  <info>string</info>           <strong>$request_data</strong>   
  <info>array</info>            <strong>$controls</strong>       
  <info>string</info>           <strong>$response_data</strong>  
  <info>string</info>           <strong>$response_oid</strong>   

<comment>Return:</comment>
  <info>LDAP\Result|bool</info>  

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


id: ldap_exop_whoami
type: function
doc:
<comment>Description:</comment>
  WHOAMI extended operation helper
  
  Performs a WHOAMI extended operation and returns the data.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  The data returned by the server, or <info>false</info> on error.

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


id: ldap_explode_dn
type: function
doc:
<comment>Description:</comment>
  Divide un DN en sus partes componentes
  
  Divide el DN devuelto por <strong>ldap_get_dn()</strong> y lo rompe en sus partes componentes. Cada parte es
  conocida como Nombre Relativo Distinguido, o RDN por sus siglas en inglés.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>           El nombre distinguido de una entidad de LDAP.
  <info>int</info>     <strong>$with_attrib</strong>  Utilizado para petición si los RDNs son devueltos con valores únicos o con
                        sus atributos.  Para obtener RDNs con los atributos (por ejemplo, en el
                        formato atributo=valor) establecer <strong>$with_attrib</strong> en 0 y obtener solamente los
                        valores establecidos en 1.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de todos los componente de un DN,  o <info>false</info> en caso de error. El primer
         elemento en el array tiene la clave <return>count</return> y representa el número de valores devueltos, los
         siguientes elementos son componentes DN numéricamente indexados.


id: ldap_first_attribute
type: function
doc:
<comment>Description:</comment>
  Devolver el primer atributo
  
  Obtiene el primer atributo de la entrada proporcionada. Los atributos restantes son devueltos al
  invocar <strong>ldap_next_attribute()</strong> sucesivamente.
  
  Similar a la lectura de las entradas, los atributos son leídos uno por uno desde una entrada en
  particular.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  
  <info></info>          <strong>$ber_identifier</strong>           <strong>$ber_identifier</strong> es el identificador hacia la ubicación del
                                      puntero de memoria interna. Este se pasa por referencia. El
                                      mismo <strong>$ber_identifier</strong> se pasa a <strong>ldap_next_attribute()</strong>, el cual
                                      modifica ese puntero.
                                      
                                      Este parámetro ya no se utiliza ya que ahora es manejado
                                      automáticamente por PHP. Por compatibilidad con versiones
                                      anteriores PHP no lanzará un error si se pasa este parámetro.

<comment>Return:</comment>
  <info>string</info>  Devuelve el primer atributo de la entrada en caso de éxito y <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_next_attribute()</strong>
   * <strong>ldap_get_attributes()</strong>


id: ldap_first_entry
type: function
doc:
<comment>Description:</comment>
  Devolver el primer resultado de identificación
  
  Devuelve el identificador de entrada para la primera entrada en el resultado. Este identificador
  de entrada se provee a la rutina <strong>ldap_next_entry()</strong> para obtener entradas sucesivas a partir del
  resultado.
  
  Las entradas en el resultado de LDAP son leídas secuencialmente utilizando las funciones
  <strong>ldap_first_entry()</strong> y <strong>ldap_next_entry()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>    Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_identifier</strong>  

<comment>Return:</comment>
  <info>resource</info>  Devuelve el identificador de la entrada de resultados para la primera entrada en caso de
            éxito, y <info>false</info> en caso de error.

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


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

<comment>Return:</comment>
  <info>resource</info>  


id: ldap_free_result
type: function
doc:
<comment>Description:</comment>
  Liberar la memoria de resultado
  
  Libera la memoria ubicada internamente para almacenar los resultados. Toda la memoria de resultado
  será liberada automáticamente cuando termine el script de ejecutarse.
  
  Típicamente, toda la memoria ubicada para el resultado de LDAP se libera al final del script. En
  caso que el script esté haciendo búsquedas sucesivas lo cual devuelve conjuntos de resultados
  largos, <strong>ldap_free_result()</strong> podría ser llamado para mantener bajo el uso de la memoria en tiempo de
  ejecución por el script.

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

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


id: ldap_get_attributes
type: function
doc:
<comment>Description:</comment>
  Obtener atributos de una entrada de búsqueda de resultados
  
  Lee atributos y valores desde una entrada en la búsqueda de resultados.
  
  Teniendo ubicada una entrada específica en el el directorio, puedes encontrar qué información es
  mantenida para esa entrada utilizando esta llamada. Podrías utilizar esta llamada para una
  aplicación la cual "navegue" entre entradas de directorio y/o donde no conozcas la estructura de
  las entradas de directorio. En muchas aplicaciones estarás buscando un atributo específico tal
  como una dirección de correo electrónico o un apellido, y no tendrás cuidado de qué otro datos
  sean mantenidos en esa búsqueda.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  

<comment>Return:</comment>
  <info>array</info>  Devuelve una entrada completa de información en un arreglo multi-dimensional en caso de
         éxito y <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_first_attribute()</strong>
   * <strong>ldap_next_attribute()</strong>


id: ldap_get_dn
type: function
doc:
<comment>Description:</comment>
  Get the DN of a result entry
  
  Finds out the DN of an entry in the result.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          An LDAP link identifier, returned by <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns the DN of the result entry and <info>false</info> on error.


id: ldap_get_entries
type: function
doc:
<comment>Description:</comment>
  Obtener todas las entradas de los resultados
  
  Lee múltiples entradas de los resultados porporcionados, luego lee los atributos y valores
  múltiples.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>    Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_identifier</strong>  

<comment>Return:</comment>
  <info>array</info>  Devuelve un resultado completo de información en un array multi-dimensional en caso de
         éxito y <info>false</info> en caso de error.
         
         La estructura del array es como sigue. El índice del atributo se convierte a minúsculas.
         (Los atributos son insensibles a mayúsculas o minúsculas para los servidores de directorio,
         pero no cuando se usan como índices de array.)

<comment>See Also:</comment>
   * <strong>ldap_first_entry()</strong>
   * <strong>ldap_next_entry()</strong>


id: ldap_get_option
type: function
doc:
<comment>Description:</comment>
  Obtener el valor actual para la opción dada
  
  Establece <strong>$retval</strong> hacia el valor de la opción especificada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>int</info>       <strong>$option</strong>           El parámetro <strong>$option</strong> puede ser uno de estos:
                              OptionType<info>LDAP_OPT_DEREF</info>integer<info>LDAP_OPT_SIZELIMIT</info>integer<info>LDAP_OPT_TIMELIMIT</info>integer<info>LDAP_OPT_NETWORK_TIMEOUT</info>integer<info>LDAP_OPT_PROTOCOL_VERSION</info>integer<info>LDAP_OPT_ERROR_NUMBER</info>integer<info>LDAP_OPT_REFERRALS</info>bool<info>LDAP_OPT_RESTART</info>bool<info>LDAP_OPT_HOST_NAME</info>string<info>LDAP_OPT_ERROR_STRING</info>string<info>LDAP_OPT_MATCHED_DN</info>string<info>LDAP_OPT_SERVER_CONTROLS</info>array<info>LDAP_OPT_X_KEEPALIVE_IDLE</info>int<info>LDAP_OPT_X_KEEPALIVE_PROBES</info>int<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info>int<info>LDAP_OPT_X_TLS_CACERTDIR</info>string<info>LDAP_OPT_X_TLS_CACERTFILE</info>string<info>LDAP_OPT_X_TLS_CERTFILE</info>string<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info>string<info>LDAP_OPT_X_TLS_CRLCHECK</info>integer<info>LDAP_OPT_X_TLS_CRLFILE</info>string<info>LDAP_OPT_X_TLS_DHFILE</info>string<info>LDAP_OPT_X_TLS_KEYILE</info>string<info>LDAP_OPT_X_TLS_PACKAGE</info>string<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info>integer<info>LDAP_OPT_X_TLS_RANDOM_FILE</info>string<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info>integer<info>LDAP_OPT_CLIENT_CONTROLS</info>array
  <info>mixed</info>     <strong>$retval</strong>           Este será establecido al valor de la 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>
   * <strong>ldap_set_option()</strong>


id: ldap_get_values
type: function
doc:
<comment>Description:</comment>
  Obtener todos los valores de una entrada de resultados
  
  Lee todos los valores del atributo en la entrada en el resultado.
  
  Esta llamada necesita un <strong>$result_entry_identifier</strong>, tal que sea precedido por una de las llamadas
  de búsqueda de ldap y una de las llamadas para obtener una entrada individual.
  
  Su solicitud será fuertemente codificada para buscar ciertos atributos (tales como "apellido" o
  "correo"), o tendrá que utilizar la llamada <strong>ldap_get_attributes()</strong> para resolver qué atributos
  existen para una entrada dada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un identificador de enlace de LDAP, devuelto por
                                      <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  
  <info>string</info>    <strong>$attribute</strong>                

<comment>Return:</comment>
  <info>array</info>  Devuelve un arreglo de valores para el atributo en caso de éxito y <info>false</info> en caso de error.
         El número de valores puede ser hallado indexando "count" en el arreglo resultante. Los
         valores individuales son accedidos por un índice entero en el arreglo. El índice primero es
         0.
         
         LDAP permite más de una entrada para un atributo, así que puede, por ejemplo, almacenar un
         número de direcciones para la entrada de directorio de una persona etiquetado con el
         atributo "correo"  return_value["count"] = Número de valores para el atributo
         return_value[0] = Primer valor del atributo return_value[i] = i-ésimo valor del atributo

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


id: ldap_get_values_len
type: function
doc:
<comment>Description:</comment>
  Obtener todos los valores binarios desde una entrada de resultados
  
  Lee todos los valores del atributo en la entrada en el resultado.
  
  Esta función es utilizada exactamente como <strong>ldap_get_values()</strong> excepto que esta maneja datos
  binarios y no datos de cadena.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un identificador de enlace de LDAP, devuelto por
                                      <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  
  <info>string</info>    <strong>$attribute</strong>                

<comment>Return:</comment>
  <info>array</info>  Devuelve un arreglo de valores para el atributo en caso de éxito y <info>false</info> en caso de error.
         Los valores individuales son accedidos por un índice entero en el arreglo. El índice
         primero es 0. El número de valores puede ser encontrado indexando "count" en el arreglo
         resultante.

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


id: ldap_list
type: function
doc:
<comment>Description:</comment>
  Búsqueda de un solo nivel
  
  Realiza la búsqueda de un <strong>$filter</strong> especificado en el directorio con el alcance de
  <info>LDAP_SCOPE_ONELEVEL</info>.
  
  <info>LDAP_SCOPE_ONELEVEL</info> quiere decir que la búsqueda solamente debería devolver información que está
  en el nivel inmediatamente abajo de el <strong>$base_dn</strong> proporcionado en la llamada. (Equivalente a
  digitar "ls" y obtener una lista de los ficheros y carpetas en el actual directorio de trabajo.)

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$base_dn</strong>          El DN base para el directorio.
  <info>string</info>    <strong>$filter</strong>           
  <info>array</info>     <strong>$attributes</strong>       Un array de atributos requeridos, por ejemplo array("correo", "sn",
                              "cn"). Tenga en cuenta que "dn" siempre es devuelto independientemente
                              de qué tipos de atributos lo soliciten.
                              
                              Utilizando este parámetro es mucho más eficiente que la acción
                              predeterminada (la cual es devolver todos los atributos y sus valores
                              asociados).  Por lo tanto, el uso de este parámetro debería ser
                              considerado una buena práctica.
  <info>int</info>       <strong>$attrsonly</strong>        Debería ser establecido a 1 solamente si los tipos de atributo son
                              solicitados. Si se establece a 0 se devuelven los tipos de atributos y
                              los valores de los atributos lo cual es el comportamiento
                              predeterminado.
  <info>int</info>       <strong>$sizelimit</strong>        Te permite limitar el conteo de entradas a devolver. Al establecer
                              esto a 0 significa que no hay límite.
                              
                              Este parámetro NO puede prevalecer sobre el sizelimit preestablecido
                              en el lado del servidor. Puede aún establecerlo a uno más bajo.
                              
                              Algunos equipos de servidor de directorio serán configurados para
                              devolver no mas que un número preestablecido de entradas. Si esto
                              ocurre, el servidor indicará que sólo ha devuelto un conjunto de
                              resultados parciales. Esto también ocurre si utiliza este parámetro
                              para limitar el conteo de entradas devueltas.
  <info>int</info>       <strong>$timelimit</strong>        Establece el número de segundos de cuánto tiempo pasa en la búsqueda.
                              Poniendo esto a 0 siginifica que no hay límite.
                              
                              Este parámetro NO puede prevalecer sobre el timelimit preestablecido
                              en el lado del servidor. Puede aún establecerlo a uno más bajo.
  <info>int</info>       <strong>$deref</strong>            Especifica cuántos alias deberían ser manejados durante la búsqueda.
                              Este puede ser uno de los siguientes: <info>LDAP_DEREF_NEVER</info> -
                              (predeterminado) Los alias nunca son dereferenciados.
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser dereferenciados durante
                              la búsqueda pero no cuando se está ubicando el objeto base de la
                              búsqueda. <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser dereferenciados
                              cuando se está ubicando el objeto base pero no durante la búsqueda.
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias siempre deberían ser dereferenciados.
                              
                              <info>LDAP_DEREF_NEVER</info> - (predeterminado) Los alias nunca son
                              dereferenciados.
                              
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser dereferenciados durante
                              la búsqueda pero no cuando se está ubicando el objeto base de la
                              búsqueda.
                              
                              <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser dereferenciados cuando se
                              está ubicando el objeto base pero no durante la búsqueda.
                              
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias siempre deberían ser dereferenciados.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador de resultado de búsqueda, o <info>false</info> en caso de error.

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


id: ldap_mod_add
type: function
doc:
<comment>Description:</comment>
  Agregar valores de atributo a los atributos actuales
  
  Agrega uno o más atributos al <strong>$dn</strong> específico. Se realiza la modificación a nivel de atributo en
  lugar de realizarce a nivel de Objeto. Las adiciones a nivel de Objeto son hechas por la función
  <strong>ldap_add()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelta por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>array</info>     <strong>$entry</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>ldap_mod_del()</strong>
   * <strong>ldap_mod_replace()</strong>


id: ldap_mod_add_ext
type: function
doc:
<comment>Description:</comment>
  Add attribute values to current attributes
  
  Does the same thing as <strong>ldap_mod_add()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_del
type: function
doc:
<comment>Description:</comment>
  Borrar valores de atributo de los atributos actuales
  
  Remueve uno o más atributos de un <strong>$dn</strong> específico. Realiza la modificación a nivel de atributo en
  lugar de hacerlo a nivel de Objeto. Las eliminaciones a nivel de Objeto son hechas por la función
  <strong>ldap_delete()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>array</info>     <strong>$entry</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>ldap_mod_add()</strong>
   * <strong>ldap_mod_replace()</strong>


id: ldap_mod_del_ext
type: function
doc:
<comment>Description:</comment>
  Delete attribute values from current attributes
  
  Does the same thing as <strong>ldap_mod_del()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_replace
type: function
doc:
<comment>Description:</comment>
  Reemplazar valores de atributos con valores nuevos
  
  Reemplaza uno o más atributos de un <strong>$dn</strong> específico. Realiza la modificación a nivel de atributo en
  lugar de hacerlo a nivel de Objeto. Las modificaciones a nivel de Objeto son hechas por la función
  <strong>ldap_modify()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>array</info>     <strong>$entry</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>ldap_mod_del()</strong>
   * <strong>ldap_mod_add()</strong>


id: ldap_mod_replace_ext
type: function
doc:
<comment>Description:</comment>
  Replace attribute values with new ones
  
  Does the same thing as <strong>ldap_mod_replace()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_modify
type: function
doc:
<comment>Description:</comment>
  Modificar una entrada de LDAP
  
  Modificar las entradas existentes en el directorio de LDAP. La estructura de la entrada es la
  misma como en <strong>ldap_add()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>array</info>     <strong>$entry</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>ldap_rename()</strong>


id: ldap_modify_batch
type: function
doc:
<comment>Description:</comment>
  Batch and execute modifications on an LDAP entry
  
  Modifies an existing entry in the LDAP directory. Allows detailed specification of the
  modifications to perform.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>                An LDAP resource, returned by <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>                  The distinguished name of an LDAP entity.
  <info>array</info>            <strong>$modifications_info</strong>  An array that specifies the modifications to make. Each
                                        entry in this array is an associative array with two or
                                        three keys: <return>attrib</return> maps to the name of the attribute to
                                        modify, <return>modtype</return> maps to the type of modification to perform,
                                        and (depending on the type of modification) <return>values</return> maps to
                                        an array of attribute values relevant to the modification.
                                        
                                        Possible values for <return>modtype</return> include: <info>LDAP_MODIFY_BATCH_ADD</info>
                                        Each value specified through <return>values</return> is added (as an
                                        additional value) to the attribute named by <return>attrib</return>.
                                        <info>LDAP_MODIFY_BATCH_REMOVE</info> Each value specified through <return>values</return>
                                        is removed from the attribute named by <return>attrib</return>. Any value of
                                        the attribute not contained in the <return>values</return> array will remain
                                        untouched. <info>LDAP_MODIFY_BATCH_REMOVE_ALL</info> All values are
                                        removed from the attribute named by <return>attrib</return>. A <return>values</return> entry
                                        must not be provided. <info>LDAP_MODIFY_BATCH_REPLACE</info> All current
                                        values of the attribute named by <return>attrib</return> are replaced with
                                        the values specified through <return>values</return>.
                                        
                                        Each value specified through <return>values</return> is added (as an
                                        additional value) to the attribute named by <return>attrib</return>.
                                        
                                        Each value specified through <return>values</return> is removed from the
                                        attribute named by <return>attrib</return>. Any value of the attribute not
                                        contained in the <return>values</return> array will remain untouched.
                                        
                                        All values are removed from the attribute named by <return>attrib</return>. A
                                        <return>values</return> entry must not be provided.
                                        
                                        All current values of the attribute named by <return>attrib</return> are
                                        replaced with the values specified through <return>values</return>.
                                        
                                        Note that any value for <return>attrib</return> must be a string, any value
                                        for <return>values</return> must be an array of strings, and any value for
                                        <return>modtype</return> must be one of the LDAP_MODIFY_BATCH_* constants
                                        listed above.
  <info>array|null</info>       <strong>$controls</strong>            Array of LDAP Controls to send with the request.

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


id: ldap_next_attribute
type: function
doc:
<comment>Description:</comment>
  Obtener el siguiente atributo en un resultado
  
  Devuelve los atributos en una entrada. La primer llamada a la función  <strong>ldap_next_attribute()</strong> es
  hecha con el parámetro  <strong>$result_entry_identifier</strong> que es devuelto por la función
  <strong>ldap_first_attribute()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un identificador de enlace de LDAP, devuelto por
                                      <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  
  <info></info>          <strong>$ber_identifier</strong>           El estado interno del puntero es mantenido por este parámetro.
                                      
                                      Este parámetro ya no se utiliza debido a que ahora es
                                      manipulado automáticamente por PHP. Por compatibilidades
                                      previas, PHP no lanzará un error si se pasa este parámetro.

<comment>Return:</comment>
  <info>string</info>  Devuelve el siguiente atributo en una entrada en caso de éxito y <info>false</info> en caso de error.

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


id: ldap_next_entry
type: function
doc:
<comment>Description:</comment>
  Obtener el siguiente resultado de entrada
  
  Devuelve las entradas almacenadas en el resultado. Las llamadas sucesivas a <strong>ldap_next_entry()</strong>
  devuelven etradas de a una por una hasta que no hayan más entradas. La primer llamada a la función
  <strong>ldap_next_entry()</strong> es hecha después de llamar a <strong>ldap_first_entry()</strong> con el parámetro
  <strong>$result_entry_identifier</strong> que es devuelto por la función <strong>ldap_first_entry()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>          Un identificador de enlace de LDAP, devuelto por
                                      <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result_entry_identifier</strong>  

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador de entrada para la entrada siguiente en el resultado, cuyas
            entradas son leídas desde el comienzo con <strong>ldap_first_entry()</strong>. Si no hay más entradas en
            el resultado entonces devuelve <info>false</info>.

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


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

<comment>Return:</comment>
  <info>resource</info>  


id: ldap_parse_exop
type: function
doc:
<comment>Description:</comment>
  Parse result object from an LDAP extended operation
  
  Parse LDAP extended operation data from result object <strong>$result</strong>

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           An <class>LDAP\Connection</class> instance, returned by <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>         An <class>LDAP\Result</class> instance, returned by <strong>ldap_list()</strong> or
                                   <strong>ldap_search()</strong>.
  <info>string</info>           <strong>$response_data</strong>  Will be filled by the response data.
  <info>string</info>           <strong>$response_oid</strong>   Will be filled by the response OID.

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


id: ldap_parse_reference
type: function
doc:
<comment>Description:</comment>
  Extraer información de la entrada de referencia
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ldap_parse_result
type: function
doc:
<comment>Description:</comment>
  Extraer información del resultado
  
  Analiza un resultado de búsqueda de LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>               Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info></info>          <strong>$result_identifier</strong>  Es un recurso de resultado de LDAP, devuelto por <strong>ldap_list()</strong> o
                                <strong>ldap_search()</strong>.
  <info>int</info>       <strong>$errcode</strong>            Es una referencia a una variable que será establecida en el código
                                de error de LDAP en el resultado, o <return>0</return> si no hubo un error.
  <info>string</info>    <strong>$matcheddn</strong>          Es una referencia a una variable que será establecida a un DN que
                                coincidió si alguno fue reconocido dentro de la solicitud, de otro
                                modo este será establecido a <info>null</info>.
  <info>string</info>    <strong>$errmsg</strong>             Es una referencia a una variable que será establecida al mensaje de
                                error de LDAP en el resultado, o será una cadena vacía si no hubo
                                error.
  <info>array</info>     <strong>$referrals</strong>          Es una referencia a una variable que será establecida a un conjunto
                                de <info>array</info> para todas las cadenas de referencia en el resultado, o un
                                array vacío si no se devuelven referencias.

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


id: ldap_read
type: function
doc:
<comment>Description:</comment>
  Leer una entrada
  
  Realiza la búsqueda de un <strong>$filter</strong> en específico en el directorio con el alcance de
  <info>LDAP_SCOPE_BASE</info>. Lo que es equivalente a leer una entrada del directorio.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un enlace identificador de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$base_dn</strong>          El DN base para el directorio.
  <info>string</info>    <strong>$filter</strong>           No se permite un filtro vacío. Si quieres devolver absolutamente toda
                              la información de esta entrada, utiliza un filtro como este
                              <return>objectClass=*</return>. Si sabes qué tipos de entradas se utilizan en el
                              servidor de directorio, podrías utilizar un filtro apropiado tal como
                              <return>objectClass=inetOrgPerson</return>.
  <info>array</info>     <strong>$attributes</strong>       Un array de los atributos requeridos, por ejemplo, array("mail", "sn",
                              "cn"). Nótese que el "dn" siempre se devuelve independientemente de
                              qué tipos de atributos son requeridos.
                              
                              Utilizar este parámetro es mucho más eficiente que la acción
                              predeterminada (la cual es devolver todos los atributos y sus valores
                              asociados).  El uso de este parámetro debería ser, por lo tanto,
                              considerado una buena práctica.
  <info>int</info>       <strong>$attrsonly</strong>        Debería ser establecido a 1 si solamente se buscan los tipos de
                              atributos. Si se establece a 0, ambos los tipos de atributos y los
                              valores de los atributos son extraídos como es el comportamiento
                              predeterminado.
  <info>int</info>       <strong>$sizelimit</strong>        Permite limitar la cuenta de entradas extraídas. Establecer esto a 0
                              significa que no hay límite.
                              
                              Este parámetro NO puede prevalecer al límite de tamaño preestablecido
                              en el lado del servidor. Aunque puedes establecerlo al más bajo.
                              
                              Algunos equipos servidores de directorio serán configurados para
                              devovler no más de un determinado número predefinido de entradas. Si
                              esto sucede, el servidor indicará que solamente ha devuelto un
                              conjunto parcial de resultados. Esto también sucede si utilizas este
                              parámetro para limitar la cuenta de las entradas extraídas.
  <info>int</info>       <strong>$timelimit</strong>        Establece el número de segundos de cuan larga será la búsqueda. Al
                              establecer esto a 0 significa que no hay límite.
                              
                              Este parámetro NO puede prevalecer al límite de tiempo preestablecido
                              en el lado del servidor. Aunque puedes establecerlo al más bajo.
  <info>int</info>       <strong>$deref</strong>            Especifica cuantos alias deberían ser manejados durante la búsqueda.
                              Este puede ser uno de los siguientes: <info>LDAP_DEREF_NEVER</info> -
                              (predeterminado) Los alias nunca son desreferenciados.
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser desreferenciados durante
                              la búsqueda pero no cuando se quiere ubicar el objeto base.
                              <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser desreferenciados cuando se
                              quiere ubicar el objeto base pero no durante la búsqueda.
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias deberían ser siempre desreferenciados.
                              
                              <info>LDAP_DEREF_NEVER</info> - (predeterminado) Los alias nunca son
                              desreferenciados.
                              
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser desreferenciados durante
                              la búsqueda pero no cuando se quiere ubicar el objeto base.
                              
                              <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser desreferenciados cuando se
                              quiere ubicar el objeto base pero no durante la búsqueda.
                              
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias deberían ser siempre desreferenciados.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador del resultado de la búsqueda o <info>false</info> en caso de error.


id: ldap_rename
type: function
doc:
<comment>Description:</comment>
  Modificar el nombre de una entrada
  
  La entrada que se especifica por <strong>$dn</strong> se renombra/mueve.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$dn</strong>               El nombre distinguido de una entidad de LDAP.
  <info>string</info>    <strong>$newrdn</strong>           El RDN nuevo.
  <info>string</info>    <strong>$newparent</strong>        La nueva entrada padre/superior.
  <info>bool</info>      <strong>$deleteoldrdn</strong>     Si es <info>true</info> se remueve el valor o valores antigüos del RDN, sino dichos
                              valores del RDN se retienen como valores no distinguidos de la
                              entrada.

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


id: ldap_rename_ext
type: function
doc:
<comment>Description:</comment>
  Modify the name of an entry
  
  Does the same thing as <strong>ldap_rename()</strong> but returns an <class>LDAP\Result</class> instance to be parsed with
  <strong>ldap_parse_result()</strong>.

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  Returns an <class>LDAP\Result</class> instance, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>ldap_rename()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_sasl_bind
type: function
doc:
<comment>Description:</comment>
  Unirse a un directorio LDAP utilizando SASL
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ldap_search
type: function
doc:
<comment>Description:</comment>
  Buscar el árbol LDAP
  
  Realiza la búsqueda de un filtro específico sobre el directorio con el alcance de
  <info>LDAP_SCOPE_SUBTREE</info>. Esto es equivalente a buscar en el directorio completo.
  
  Desde la versión 4.0.5 en adelante, también es posible hacer búsquedas paralelas. Para hacer esto
  se utiliza un array de identificadores de enlace, en lugar de un simple identificador, como el
  primer argumento. Si no quieres el mismo DN y el mismo filtro para todas las búsquedas, puedes
  utilizar también un array de DNs base y/o un array de filtros. Esos arrays deben ser del mismo
  tamaño como el de el array del identificador de enlace ya que, las primeras entradas de los arrays
  son utilizadas por una búsqueda, las segundas entradas son utilizadas para otra, y así. Cuando se
  hacen búsquedas en paralelo se devuelve un array de identificadores del resultado de la búsqueda,
  exceptuando en caso de error, la entrada que corresponde a la búsqueda será <info>false</info>. Esto es muy
  parecido a los valores que normalmente se devuelven, excepto que un identificador de resultado
  siempre es devuelto cuando se hace una búsqueda. Hay algunos casos raros donde el resultado normal
  de la búsqueda devuelve <info>false</info> mientras que la búsqueda paralela devuelve un identificador.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>string</info>    <strong>$base_dn</strong>          El DN base para el directorio.
  <info>string</info>    <strong>$filter</strong>           El filtro de búsqueda puede ser simple o avanzado, utilizando
                              operadores booleanos en el formato descrito en la documentación de
                              LDAP (ver el Directorio del SDK Netscape o el RFC4515 para la
                              información completa sobre filtros).
  <info>array</info>     <strong>$attributes</strong>       Un array de los atributos requeridos, por ejemplo, <return>array("mail", "sn",
                              "cn")</return>. Nótese que el "dn" siempre es devuelto independientemente de
                              qué tipos de atributos sean requeridos.
                              
                              Utilizando este parámetro es mucho más eficiente que la acción
                              predeterminada (la cual es devolver todos los atributos y sus valores
                              asociados).  El uso de este parámetro debería ser considerado una
                              buena práctica.
  <info>int</info>       <strong>$attrsonly</strong>        Debería ser establecido a 1 si sólo se buscan tipos de atributos. Si
                              se establece a 0 los valores de atributos y los tipos de atributos se
                              muestran tal cual es el comportamiento predeterminado.
  <info>int</info>       <strong>$sizelimit</strong>        Te permite limitar la cantidad de entradas a mostrar. Al establecer
                              esto a 0 siginifica que no hay límite.
                              
                              Este parámetro NO puede prevalecer sobre el sizelimit preestablecido
                              en el lado del servidor. Puede aún establecerlo a uno más bajo.
                              
                              Algunos equipos de servidor de directorio serán configurados para
                              devolver no mas que un número preestablecido de entradas. Si esto
                              ocurre, el servidor indicará que sólo ha devuelto un conjunto de
                              resultados parciales. Esto también ocurre si utiliza este parámetro
                              para limitar el conteo de entradas devueltas.
  <info>int</info>       <strong>$timelimit</strong>        Establece el número de segundos de cuánto tiempo pasa en la búsqueda.
                              Poniendo esto a 0 siginifica que no hay límite.
                              
                              Este parámetro NO puede prevalecer sobre el timelimit preestablecido
                              en el lado del servidor. Puede aún establecerlo a uno más bajo.
  <info>int</info>       <strong>$deref</strong>            Especifica cuántos alias deberían ser manejados durante la búsqueda.
                              Este puede ser uno de los siguientes: <info>LDAP_DEREF_NEVER</info> -
                              (predeterminado) Los alias nunca son dereferenciados.
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser dereferenciados durante
                              la búsqueda pero no cuando se está ubicando el objeto base de la
                              búsqueda. <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser dereferenciados
                              cuando se está ubicando el objeto base pero no durante la búsqueda.
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias siempre deberían ser dereferenciados.
                              
                              <info>LDAP_DEREF_NEVER</info> - (predeterminado) Los alias nunca son
                              dereferenciados.
                              
                              <info>LDAP_DEREF_SEARCHING</info> - Los alias deberían ser dereferenciados durante
                              la búsqueda pero no cuando se está ubicando el objeto base de la
                              búsqueda.
                              
                              <info>LDAP_DEREF_FINDING</info> - Los alias deberían ser dereferenciados cuando se
                              está ubicando el objeto base pero no durante la búsqueda.
                              
                              <info>LDAP_DEREF_ALWAYS</info> - Los alias siempre deberían ser dereferenciados.
  <info>array</info>     <strong>$serverctrls</strong>      Array de Controles de LDAP a enviar con la petición.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador de resultado de búsqueda, o <info>false</info> en caso de error.


id: ldap_set_option
type: function
doc:
<comment>Description:</comment>
  Establecer el valor de la opción proporcionada
  
  Establece el valor de la opción especificada a <strong>$newval</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>int</info>       <strong>$option</strong>           El parámetro <strong>$option</strong> puede ser uno de estos: OptionTypeAvailable
                              since<info>LDAP_OPT_DEREF</info>integer<info>LDAP_OPT_SIZELIMIT</info>integer<info>LDAP_OPT_TIMELIMIT</info>integer<info>LDAP_OPT_NETWORK_TIMEOUT</info>integerPHP
                              5.3.0<info>LDAP_OPT_PROTOCOL_VERSION</info>integer<info>LDAP_OPT_ERROR_NUMBER</info>integer<info>LDAP_OPT_REFERRALS</info>bool<info>LDAP_OPT_RESTART</info>bool<info>LDAP_OPT_HOST_NAME</info>string<info>LDAP_OPT_ERROR_STRING</info>string<info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info>string<info>LDAP_OPT_MATCHED_DN</info>string<info>LDAP_OPT_SERVER_CONTROLS</info>array<info>LDAP_OPT_CLIENT_CONTROLS</info>array<info>LDAP_OPT_X_KEEPALIVE_IDLE</info>intPHP
                              7.1.0<info>LDAP_OPT_X_KEEPALIVE_PROBES</info>intPHP
                              7.1.0<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info>intPHP
                              7.1.0<info>LDAP_OPT_X_TLS_CACERTDIR</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_CACERTFILE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_CERTFILE</info>PHP
                              7.1.0<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_CRLCHECK</info>integerPHP
                              7.1.0<info>LDAP_OPT_X_TLS_CRLFILE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_DHFILE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_KEYFILE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info>integerPHP
                              7.1.0<info>LDAP_OPT_X_TLS_RANDOM_FILE</info>stringPHP
                              7.1.0<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info>integerPHP 7.0.5
                              
                              <info>LDAP_OPT_SERVER_CONTROLS</info> y  <info>LDAP_OPT_CLIENT_CONTROLS</info> solicitan una
                              lista de controles, lo que significa que el valor debe ser un array de
                              controles. Un control consiste en un oid identificando el control, un
                              value opcional, y un indicador opcional representado por criticality.
                              En PHP un control es proporcionado por un array que contiene un
                              elemento con la clave oid, una cadena de valor, y dos elementos
                              opcionales. Los elementos opcionales son la clave value con un valor
                              de tipo cadena, y la clave iscritical con un valor de tipo booleano.
                              El valor de la clave iscritical de forma predeterminada es <info>false</info> si no
                              es provisto. Vea draft-ietf-ldapext-ldap-c-api-xx.txt para más
                              detalles. Vea también el segundo ejemplo a continuación.
  <info>mixed</info>     <strong>$newval</strong>           El nuevo valor para el <strong>$option</strong> especificado.

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


id: ldap_set_rebind_proc
type: function
doc:
<comment>Description:</comment>
  Establece una función de devolución de llamada para realizar revinculaciones en el rastreo
  referencial
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ldap_sort
type: function
doc:
<comment>Description:</comment>
  Clasificar entradas de resultados de LDAP en el lado del cliente
  
  Clasificar el resultado de una búsqueda LDAP, devuelta por <strong>ldap_search()</strong>.
  
  Como esta función clasifica los valores devueltos en el lado del cliente, es posible que  no pueda
  obtener los resultados esperados en caso que alcance el tamaño de límite <strong>$sizelimit</strong> ya sea del
  servidor o el que está definido dentro de <strong>ldap_search()</strong>.
  
  Esta característica ha sido declarada
  OBSOLETA a partir de PHP 7.0.0. Su uso está
  totalmente desaconsejado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Un identificador de enlace de LDAP, devuelto por <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result</strong>      Un identificador de resultado de búsqueda, devuelto por <strong>ldap_search()</strong>.
  <info>string</info>    <strong>$sortfilter</strong>  El atributo a utilizar como clave en la clasificación.

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


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

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


id: ldap_t61_to_8859
type: function
doc:
<comment>Description:</comment>
  Traduce del conjunto de caracteres t61 al conjunto de caracteres 8859
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ldap_unbind
type: function
doc:
<comment>Description:</comment>
  Desenlazar de directorio LDAP
  
  Desenlace de directorio LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Un identificador de enlace LDAP, devuelto por <strong>ldap_connect()</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>ldap_bind()</strong>


id: levenshtein
type: function
doc:
<comment>Description:</comment>
  Cálculo de la distancia Levenshtein entre dos strings
  
  La distancia Levenshtein se define como el número mínimo de caracteres que se tienen que
  sustituir, insertar o borrar para transformar <strong>$str1</strong> en <strong>$str2</strong>. La complejidad del algoritmo es
  <return>O(m*n)</return>, donde <return>n</return> y <return>m</return> son la longitud de <strong>$str1</strong> y <strong>$str2</strong> (bastante bueno en comparación con
  <strong>similar_text()</strong>, la cual es O(max(n,m)**3), pero sigue siendo costoso).
  
  En su forma más simple la función tomará sólo los dos strings como parámetros y calculará sólo el
  número de operaciones de insertar, reemplazar y eliminar, necesarias para transformar <strong>$str1</strong> en
  <strong>$str2</strong>.
  
  Una segunda variante tomará tres parámetros adicionales que definen el costo de las operaciones de
  insertar, reemplazar y eliminar. Esto es más general y adaptable que la primera variante, pero no
  tan eficiente.

<comment>Param:</comment>
  <info>string</info>  <strong>$str1</strong>      Uno de los strings a ser evaluados para la distancia Levenshtein.
  <info>string</info>  <strong>$str2</strong>      Uno de los strings a ser evaluados para la distancia Levenshtein.
  <info>int</info>     <strong>$cost_ins</strong>  Define el costo de inserción.
  <info>int</info>     <strong>$cost_rep</strong>  Define el costo de reemplazo.
  <info>int</info>     <strong>$cost_del</strong>  Define el costo de eliminación.

<comment>Return:</comment>
  <info>int</info>  Esta función devuelve la distancia Levenshtein entre los dos strings argumentos ó -1, si uno
       de los strings argumentos es mayor que el límite de 255 caracteres.

<comment>See Also:</comment>
   * <strong>soundex()</strong>
   * <strong>similar_text()</strong>
   * <strong>metaphone()</strong>


id: libXMLError
type: class
doc:
<comment>Description:</comment>
  Contiene diversa información sobre los errores lanzados por libxml. Los códigos de error son
  descritos en la documentación de la API xmlError oficial.


id: libxml_clear_errors
type: function
doc:
<comment>Description:</comment>
  Limpia el buffer de errores de libxml
    
  
  <strong>libxml_clear_errors()</strong> limpia el buffer de errores de libxml.

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

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_get_last_error()</strong>


id: libxml_disable_entity_loader
type: function
doc:
<comment>Description:</comment>
  Deshabilita la capacidad de cargar entidades externas
  
  Habilita/deshabilita la capacidad de cargar entidades externas.

<comment>Param:</comment>
  <info>bool</info>  <strong>$disable</strong>  Deshabilita (<info>true</info>) o habilita (<info>false</info>) extensiones libxml (tal como ,  y ) para
                  cargar entidades externas.

<comment>Return:</comment>
  <info>bool</info>  Devuelve el valor anterior.

<comment>See Also:</comment>
   * <strong>libxml_use_internal_errors()</strong>
   * La constante <info>LIBXML_NONET</info>


id: libxml_get_errors
type: function
doc:
<comment>Description:</comment>
  Recupera un array de errores
    
  
  Recupera un array de errores.

<comment>Return:</comment>
  <info>array</info>  Recupera un array con objetos de tipo <info>LibXMLError</info> si hay errores en el buffer, o un array
         vacío en caso contrario.

<comment>See Also:</comment>
   * <strong>libxml_get_last_error()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_get_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Get the current external entity loader
  
  Get external entity loader previously installed by <strong>libxml_set_external_entity_loader()</strong>.

<comment>Return:</comment>
  <info>callable|null</info>  The external entity loader previously installed by
                 <strong>libxml_set_external_entity_loader()</strong>. If that function was never called, or if it
                 was called with <info>null</info>, <info>null</info> will be returned.

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


id: libxml_get_last_error
type: function
doc:
<comment>Description:</comment>
  Recupera el último error de libxml
    
  
  Recupera el último error de libxml.

<comment>Return:</comment>
  <info>LibXMLError</info>  Devuelve un objeto de tipo <info>LibXMLError</info> si hay algún error en el buffer, o <info>false</info> en
               caso contrario.

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_set_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Cambia el cargador externo por defecto de entidades
  
  Cambia el cargador externo por defecto de entidades.

<comment>Param:</comment>
  <info>callable</info>  <strong>$resolver_function</strong>  Un <info>callable</info> que acepte tres argumentos. Dos strings: una id pública
                                y una id de sistema, y un contexto (un array con cuatro elementos)
                                como tercer argumento. Este callback debe devolver un resource, una
                                cadena a partir de la cual s epueda abrir un resource, 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.

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


id: libxml_set_streams_context
type: function
doc:
<comment>Description:</comment>
  Configura el contexto de flujo para el próximo documento libxml cargado o escrito
    
  
  Configura el contexto de flujo para el próximo documento libxml cargado o escrito.

<comment>Param:</comment>
  <info>resource</info>  <strong>$streams_context</strong>  El contexto de flujo de tipo resource (creado con la función
                              <strong>stream_context_create()</strong>)

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

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


id: libxml_use_internal_errors
type: function
doc:
<comment>Description:</comment>
  Deshabilita errores libxml y permite al usuario extraer información de errores según sea
  necesario
    
  
  <strong>libxml_use_internal_errors()</strong> permite deshabilitar errores libxml estándares y habilitar el manejo
  de errores del usuario.

<comment>Param:</comment>
  <info>bool</info>  <strong>$use_errors</strong>  Habilita (<info>true</info>) o deshabilita (<info>false</info>) el manejo de errores por parte del
                     usuario. La deshabilitación también borrará cualquier error libxml existente.

<comment>Return:</comment>
  <info>bool</info>  Esta función devuelve el valor anterior de <strong>$use_errors</strong>.

<comment>See Also:</comment>
   * <strong>libxml_clear_errors()</strong>
   * <strong>libxml_get_errors()</strong>


id: link
type: function
doc:
<comment>Description:</comment>
  Crea un enlace duro
  
  <strong>link()</strong> crea un enlace duro.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  El objetivo del enlace.
  <info>string</info>  <strong>$link</strong>    El nombre del enlace.

<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>symlink()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>


id: linkinfo
type: function
doc:
<comment>Description:</comment>
  Obtiene información acerca de un enlace
  
  Obtiene información acerca de un enlace.
  
  Esta función se usa para verificar si un enlace (apuntado por <strong>$path</strong>) existe realmente (usando el
  mismo método que la macro S_ISLNK definida en stat.h).

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Ruta del enlce.

<comment>Return:</comment>
  <info>int</info>  <strong>linkinfo()</strong> devuelve el campo <return>st_dev</return> de la estructura de estadísticas de C en Unix devuelta
       por la llamada al sistema de <return>lstat</return>. Devuelve 0 o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>link()</strong>
   * <strong>readlink()</strong>


id: list
type: function
doc:
<comment>Description:</comment>
  Asignar variables como si fueran un array
  
  Al igual que <strong>array()</strong>, no es realmente una función, es un constructor del lenguaje. <strong>list()</strong> se
  utiliza para asignar una lista de variables en una sola operación.
  
  <strong>list()</strong> solo funciona con arrays numéricos y supone que los índices numéricos empiezan en 0.
  
  En PHP 5, <strong>list()</strong> asigna los valores empezando desde el parámetro más a la derecha. En PHP 7,
  <strong>list()</strong> empieza desde el parámetro más a la izquierda.
  
  Si se emplean variables simples, esto no debería ser un problema. Pero se en emplean arrays con
  índices, normalmente se espera que el orden de los índices sea el mismo que el escrito en <strong>list()</strong>,
  de izquierda a derecha, no siendo este el caso en PHP 5, ya que se asignan en orden inverso.
  
  En términos generales, se aconseja evitar depender de un orden específico de operación debido a
  que este podría cambiar de nuevo en el futuro.
  
  La modificación del array durante la ejecución de <strong>list()</strong> (p.ej. usando <return>list($a, $b) = $b</return>)
  resultará en un comportamiento indefinido.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var1</strong>  Una variable.

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

<comment>See Also:</comment>
   * <strong>each()</strong>
   * <strong>array()</strong>
   * <strong>extract()</strong>


id: localeconv
type: function
doc:
<comment>Description:</comment>
  Obtener información sobre el formato numérico
  
  Devuelve una matriz asociativa que contiene información de los formatos numérico y monetario,
  localizados.

<comment>Return:</comment>
  <info>array</info>  <strong>localeconv()</strong> devuelve información basada en la localidad actual, tal y como haya sido
         definida mediante <strong>setlocale()</strong>. La matriz asociativa que devuelve contiene los siguientes
         campos: Elemento de la matrizDescripcióndecimal_pointCaracter de punto
         decimalthousands_sepSeparador de milesgroupingMatriz que contiene agrupaciones
         numéricasint_curr_symbolSímbolo internacional de moneda (i.e. USD)currency_symbolSímbolo
         local de moneda (i.e. $)mon_decimal_pointCaracter de punto decimal
         monetariomon_thousands_sepSeparador de miles monetariomon_groupingMatriz que contiene
         agrupaciones de monedapositive_signSigno para valores positivosnegative_signSigno para
         valores negativosint_frac_digitsDígitos fraccionarios internacionalesfrac_digitsDígitos
         fraccionarios localesp_cs_precedes<info>true</info> si currency_symbol precede un valor positivo, <info>false</info>
         si lo sucede p_sep_by_space<info>true</info> si un espacio separa currency_symbol de un valor positivo,
         <info>false</info> de lo contrario n_cs_precedes<info>true</info> si currency_symbol precede un valor negativo, <info>false</info>
         si lo sucede n_sep_by_space<info>true</info> si un espacio separa currency_symbol de un valor negativo,
         <info>false</info> de lo contrario p_sign_posn0 - Paréntesis rodean la cantidad y currency_symbol1 - La
         cadena de signo precede la cantidad y currency_symbol2 - La cadena de signo sucede la
         cantidad y currency_symbol3 - La cadena de signo precede inmediatamente currency_symbol4 -
         La cadena de signo sucede inmediatamente currency_symboln_sign_posn0 - Paréntesis rodean la
         cantidad y currency_symbol1 - La cadena de signo precede la cantidad y currency_symbol2 -
         La cadena de signo sucede la cantidad y currency_symbol3 - La cadena de signo precede
         inmediatamente currency_symbol4 - La cadena de signo sucede inmediatamente currency_symbol
         
         Los valores de <return>p_sign_posn</return> y <return>n_sign_posn</return> contienen una cadena de opciones de formato. Cada
         número representa una de las condiciones listadas anteriormente.
         
         Los campos de agrupamiento contienen matrices que definen el modo en que los números deben
         ser agrupados. Por ejemplo, el campo de agrupamiento monetario para la localidad nl_NL (en
         modo UTF-8 con el signo de euro), tendría una matriz de 2 elementos con los valores 3 y 3.
         Entre más alto sea el índice dentro de la matriz, lo más lejos hacia la izquierda se
         encuentra el agrupamiento. Si un elemento de la matriz es igual a <info>CHAR_MAX</info>, no se realiza
         ningún agrupamiento posterior. Si un elemento de la matriz es igual a 0, el elemento
         anterior deberá ser usado.

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


id: localtime
type: function
doc:
<comment>Description:</comment>
  Obtiene fecha y hora local
  
  La función <strong>localtime()</strong> devuelve un array con la estructura idéntica a la devuelta por la llamada a
  la función en C.

<comment>Param:</comment>
  <info>int</info>   <strong>$timestamp</strong>       El parámetro opcional <strong>$timestamp</strong> es una marca temporal de Unix de tipo
                         <info>integer</info> que por defecto es la hora local si no se proporciona ningún valor
                         a <strong>$timestamp</strong>. En otras palabras, es de forma predeterminada el valor de la
                         función <strong>time()</strong>.
  <info>bool</info>  <strong>$is_associative</strong>  Si está defindo como <info>false</info> o no se proporciona, el array es devuelto como
                         un array indexado numéricamente. Si el argumento está definido como <info>true</info>,
                         <strong>localtime()</strong> devuelve un array asociativo que contiene todos los diferentes
                         elementos de la estructura devuelta por la llamada a la fucnión de C
                         localtime. Los nombres de las diferentes claves del array asociativo son
                         los siguientes:
                         
                          "tm_sec" - segundos, <return>0</return> a <return>59</return>  "tm_min" - minutos, <return>0</return> a <return>59</return>  "tm_hour" -
                         horas, <return>0</return> a <return>23</return>  "tm_mday" - día del mes, <return>1</return> a <return>31</return>  "tm_mon" - mes del año, <return>0</return>
                         (Ene) a <return>11</return> (Dic)  "tm_year" - años desde 1900  "tm_wday" - día de la
                         semana, <return>0</return> (Domingo) a <return>6</return> (Sábado)  "tm_yday" - día del año, <return>0</return> to <return>365</return>
                         "tm_isdst" - ¿Está en horario de verano?   Valor positivo si es que sí, <return>0</return>
                         si es que no, negativo en caso que no se sepa.
                         
                         "tm_sec" - segundos, <return>0</return> a <return>59</return>
                         
                         "tm_min" - minutos, <return>0</return> a <return>59</return>
                         
                         "tm_hour" - horas, <return>0</return> a <return>23</return>
                         
                         "tm_mday" - día del mes, <return>1</return> a <return>31</return>
                         
                         "tm_mon" - mes del año, <return>0</return> (Ene) a <return>11</return> (Dic)
                         
                         "tm_year" - años desde 1900
                         
                         "tm_wday" - día de la semana, <return>0</return> (Domingo) a <return>6</return> (Sábado)
                         
                         "tm_yday" - día del año, <return>0</return> to <return>365</return>
                         
                         "tm_isdst" - ¿Está en horario de verano?
                         
                         Valor positivo si es que sí, <return>0</return> si es que no, negativo en caso que no se
                         sepa.

<comment>Return:</comment>
  <info>array</info>  

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


id: log
type: function
doc:
<comment>Description:</comment>
  Logaritmo natural
  
  Si se especifica el parámetro opcional <strong>$base</strong>,  <strong>log()</strong> devuelve logbase <strong>$arg</strong>, y en caso contrario
  <strong>log()</strong>  devuelve el logaritmo natural de <strong>$arg</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$arg</strong>   El valor al que se desea calcular el logaritmo
  <info>float</info>  <strong>$base</strong>  La base opcinal del logaritmo a usar (por omisión es 'e' y por lo tanto el logaritmo
                natural).

<comment>Return:</comment>
  <info>float</info>  El logaritmo de <strong>$arg</strong> en la base dada por   <strong>$base</strong>, si se indica, o en su lugar el logaritmo
         natural.

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


id: log10
type: function
doc:
<comment>Description:</comment>
  Logaritmo en base 10
  
  Devuelve el logaritmo en base 10 de <strong>$arg</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$arg</strong>  El argumento a procesar

<comment>Return:</comment>
  <info>float</info>  El logaritmo en base 10 de <strong>$arg</strong>

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


id: log1p
type: function
doc:
<comment>Description:</comment>
  Devuelve log(1 + numero), calculado de tal forma que no pierde precisión 
     incluso cuando el valor del numero se aproxima a cero.
    
  
  <strong>log1p()</strong> devuelve el equivalente a log(1 + <strong>$number</strong>) calculado de tal forma que no pierde precisión
  incluso cuando el valor de <strong>$number</strong> se aproxima a cero. <strong>log()</strong> puede devolver sólo log(1) en este
  caso debido a la falta de precisión.

<comment>Param:</comment>
  <info>float</info>  <strong>$number</strong>  El argumento a procesar

<comment>Return:</comment>
  <info>float</info>  log(1 + <strong>$number</strong>)

<comment>See Also:</comment>
   * <strong>expm1()</strong>
   * <strong>log()</strong>
   * <strong>log10()</strong>


id: long2ip
type: function
doc:
<comment>Description:</comment>
  Convierte una dirección de red (IPv4) en una cadena de texto en formato con puntos estándar de
  internet
  
  La función <strong>long2ip()</strong> genera una dirección de internet en formato de puntos (por ejemplo.:
  aaa.bbb.ccc.ddd) a partir de una correcta representación de la dirección.

<comment>Param:</comment>
  <info>int</info>  <strong>$proper_address</strong>  Correcta representación de la dirección.

<comment>Return:</comment>
  <info>string</info>  Devuelve una dirección IP de internet como cadena de texto.

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


id: lstat
type: function
doc:
<comment>Description:</comment>
  Da información acerca de un archivo o enlace simbólico
  
  Reúne las estadísticas del archivo o enlace simbólico nombrado por <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta de un archivo o enlace simbólico.

<comment>Return:</comment>
  <info>array</info>  Vea la página del manual de <strong>stat()</strong> para información sobre la estructura de la matriz que
         devuelve <strong>lstat()</strong>. Esta función es idéntica a la función <strong>stat()</strong> excepto que si el parámetro
         <strong>$filename</strong> es un enlace simbólico, se devuelve el estado del enlace simbólico, no el estado
         del archivo apuntado por el enlace simbólico.

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


id: ltrim
type: function
doc:
<comment>Description:</comment>
  Retira espacios en blanco (u otros caracteres) del inicio de un string
  
  Retira espacios en blanco (u otros caracteres) del inicio de un string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>             El string de entrada.
  <info>string</info>  <strong>$character_mask</strong>  Se puede también especificar los caracteres que se desean retirar por
                           medio del parámetro <strong>$character_mask</strong>. Simplemente se listan todos los
                           caracteres que se quieren retirar. Con <return>..</return> se puede especificar un rango
                           de caracteres.

<comment>Return:</comment>
  <info>string</info>  Esta función devuelve un string con los espacios en blanco retirados del inicio de <strong>$str</strong>.
          Sin el segundo parámetro, <strong>ltrim()</strong> retirará estos caracteres:   " " (ASCII <return>32</return> (<return>0x20</return>)), un
          espacio ordinario.  "\t" (ASCII <return>9</return> (<return>0x09</return>)), un tabulador.  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), una
          nueva línea (line feed).  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), un retorno de carro.  "\0" (ASCII <return>0</return>
          (<return>0x00</return>)), el byte <return>NULL</return>.  "\x0B" (ASCII <return>11</return> (<return>0x0B</return>)), un tabulador vertical.
          
          " " (ASCII <return>32</return> (<return>0x20</return>)), un espacio ordinario.
          
          "\t" (ASCII <return>9</return> (<return>0x09</return>)), un tabulador.
          
          "\n" (ASCII <return>10</return> (<return>0x0A</return>)), una nueva línea (line feed).
          
          "\r" (ASCII <return>13</return> (<return>0x0D</return>)), un retorno de carro.
          
          "\0" (ASCII <return>0</return> (<return>0x00</return>)), el byte <return>NULL</return>.
          
           "\x0B" (ASCII <return>11</return> (<return>0x0B</return>)), un tabulador vertical.

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


id: lzf_compress
type: function
doc:
<comment>Description:</comment>
  Compresión LZF
    
  
  <strong>lzf_compress()</strong> comprime el string <strong>$data</strong> dado utilizando codificación LZF.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  El string a comprimir.

<comment>Return:</comment>
  <info>string</info>  Devuelve los datos comprimidos o <info>false</info> si ocurrió un error.

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


id: lzf_decompress
type: function
doc:
<comment>Description:</comment>
  Descompresión LZF
    
  
  <strong>lzf_compress()</strong> descomprime la cadena <strong>$data</strong> dada que contiene los datos codificados en lzf.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La cadena comprimida.

<comment>Return:</comment>
  <info>string</info>  Devuelve los datos descomprimidos o <info>false</info> si ocurrió un error.

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


id: lzf_optimized_for
type: function
doc:
<comment>Description:</comment>
  Determina para qué fue optimizada la extensión LZF
    
  
  Determina para qué fue optimizada la extensión LZF durante la compilación.

<comment>Return:</comment>
  <info>int</info>  Devuelve 1 si LZF fue optimizada para velocidad, 0 para compresión.


id: mail
type: function
doc:
<comment>Description:</comment>
  Enviar correo
  
  Envía un correo electrónico.

<comment>Param:</comment>
  <info>string</info>  <strong>$to</strong>                     Destinatario/s del correo.
                                  
                                  El formato de este string debe cumplir con la RFC 2822. Algunos
                                  ejemplos son: usuario@example.comusuario@example.com,
                                  otrousuario@example.comUsuario \<usuario@example.com&gt;Usuario \<usuario@example.com&gt;, Otro usuario \<otrousuario@example.com&gt;
  <info>string</info>  <strong>$subject</strong>                Título del correo electrónico a enviar.
                                  
                                  El título debe cumplir con la RFC 2047.
  <info>string</info>  <strong>$message</strong>                Mensaje a enviar.
                                  
                                  Cada línea debería separarse con un CRLF (\r\n). Las líneas no
                                  deberían ocupar más de 70 caracteres.
                                  
                                  (Sólo en Windows) Cuando PHP se comunica directamente con un
                                  servidor SMTP, si encuentra un punto al principio de la línea,
                                  éste se elimina. Para evitar esto es necesario reemplazar estas
                                  apariciones con un doble punto.
                                  ]]>
  <info>string</info>  <strong>$additional_headers</strong>     String a insertar al final de la cabecera del correo.
                                  
                                  Se usa normalmente para añadir cabeceras extra (From, Cc y Bcc).
                                  Las cabeceras múltiples adicionales deberían separarse con un
                                  CRLF(\r\n). Si se usan datos externos para componer esta cabecera,
                                  los datos deberían ser saneados para que no se inyecten cabeceras
                                  no deseadas.
                                  
                                  <strong>$additional_headers</strong> no posee protección de inyección de cabeceras
                                  de correo. Por tanto, los usuarios deben asegurarse de que las
                                  cabeceras especificadas son seguras y contienen solamente
                                  cabeceras. Es decir, nunca iniciar el cuerpo del correo con varias
                                  nuevas líneas.
                                  
                                  Cuando se envía un correo, este debe contener una cabecera <return>From</return>.
                                  Puede establecerse con el parámetro <strong>$additional_headers</strong>, o puede
                                  definirse un valor predeterminaro en php.ini.
                                  
                                  Si no se realiza esta acción se obtendrá un mensaje de error
                                  similar a <return>Warning: mail(): "sendmail_from" not set in php.ini or
                                  custom "From:" header missing (Advertencia: mail():
                                  "sendmail_from" no establecido en php.ini o falta la cabecera
                                  personalizada "From:")</return>. La cabecera <return>From</return> también establece
                                  <return>Return-Path</return> bajo Windows.
                                  
                                  Si no se reciben los mensajes enviados, intente usar solamente LF
                                  (\n). Algunos agentes de transferencia de correo de Unix (como
                                  qmail) reemplzan LF por CRLF automáticamente (lo que conlleva
                                  doblar CR si se usa CRLF). Esto debería ser el último recurso,
                                  pues no cumple con la RFC 2822.
  <info>string</info>  <strong>$additional_parameters</strong>  El parámetro <strong>$additional_parameters</strong> puede usarse para indicar
                                  opciones adicionales como opciones de línea de comandos al
                                  programa que está configurado para usarse cuando se envía correo,
                                  definido por la opción de configuración <return>sendmail_path</return>. Por
                                  ejemplo, puede usarse para establecer la dirección de correo del
                                  remitente usando sendmail con su opción <return>-f</return>.
                                  
                                  Este parámetro es escapado internamente por <strong>escapeshellcmd()</strong> para
                                  prevenir la ejecución del comando. Aunque <strong>escapeshellcmd()</strong> evita
                                  la ejecución del comando, permite añadir parámetros adicionales.
                                  Por razones de seguridad, se recomienda que el usuario sanee este
                                  parámetro para evitar que se añadan parámetros indeseados al
                                  comando.
                                  
                                  Ya que <strong>escapeshellcmd()</strong> se aplica automáticamente, algunos
                                  caracteres que están permitidos como direcciones de correo
                                  electrónico por algún RFC no se pueden usar. <strong>mail()</strong> no puede
                                  permitir tales caracteres, por lo que en programas donde el uso de
                                  tales caracters sea necesario, se recomienda una vía alternativa
                                  de enviar correos (como usar un marco de trabajo o una
                                  biblioteca).
                                  
                                  El usuario usado por el servidor web debería ser añadido como
                                  usuario de confianza en la configuración de sendmail para evitar
                                  que se añada la cabecera 'X-Warning' al mensaje cuando se añada la
                                  dirección de remitente (-f) usando este método. Para los usuarios
                                  de sendmail, este fichero es /etc/mail/trusted-users.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el correo ha sido aceptado para su envío, de lo contrario <info>false</info>.
        
        Es importante tener en cuenta que si el correo es aceptado para su envío, NO quiere decir
        que el correo haya alcanzado el destino indicado.

<comment>See Also:</comment>
   * <strong>imap_mail()</strong>
   * PEAR::Mail
   * PEAR::Mail_Mime


id: mailparse_determine_best_xfer_encoding
type: function
doc:
<comment>Description:</comment>
  Obtiene la mejor forma de codificar
  
  Encuentra la mejor forma de codificar el contenido leído del apuntador de archivo dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  Un apuntador de archivo válido, que reciba operaciones de búsqueda.

<comment>Return:</comment>
  <info>string</info>  Devuelve una de las codificaciones de caracteres soportadas por el módulo mbstring.


id: mailparse_msg_create
type: function
doc:
<comment>Description:</comment>
  Crea un recurso de correo mime
  
  Crea un recurso tipo correo <return>MIME</return>.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un recurso que puede ser usado para interpretar un mensaje.

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


id: mailparse_msg_extract_part
type: function
doc:
<comment>Description:</comment>
  Extrae/decodifica una sección de mensaje
    
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Un recurso <return>MIME</return> válido.
  <info>string</info>    <strong>$msgbody</strong>       
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part_file()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_part_file
type: function
doc:
<comment>Description:</comment>
  Extrae/decodifica una sección de mensaje
  
  Extrae/decodifica una sección de mensaje del archivo indicado.
  
  Los contenidos de la sección serán decodificados de acuerdo a su codificación de transferencia -
  se soportan base64, imprimible-con-comillas y texto uuencode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Un recurso <return>MIME</return> válido, creado con <strong>mailparse_msg_create()</strong>.
  <info>mixed</info>     <strong>$filename</strong>      Puede ser un nombre de archivo o un recurso de secuencia válido.
  <info>callable</info>  <strong>$callbackfunc</strong>  Si se define, este parámetro debe ser una llamada de retorno válida, a la
                           cual le será pasada la sección extraída, o <info>null</info> para asegurarse de que
                           esta función devuelva la sección extraída.
                           
                           Si no se especifica, los contenidos serán enviados a "stdout".

<comment>Return:</comment>
  <info>string</info>  Si <strong>$callbackfunc</strong> es diferente de <info>null</info> devuelve <info>true</info> en caso de éxito.
          
          Si <strong>$callbackfunc</strong> es <info>null</info>, devuelve la sección extraída como una cadena.
          
          Devuelve <info>false</info> en caso de fallo.

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_whole_part_file
type: function
doc:
<comment>Description:</comment>
  Extrae una sección del mensaje incluyendo cabeceras sin descodificar la transferencia codificada
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Un recurso <return>MIME</return> válido.
  <info>string</info>    <strong>$filename</strong>      
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_part_file()</strong>


id: mailparse_msg_free
type: function
doc:
<comment>Description:</comment>
  Libera un recurso MIME
  
  Libera un recurso <return>MIME</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Un recurso <return>MIME</return> válido reservado por <strong>mailparse_msg_create()</strong> o
                       <strong>mailparse_msg_parse_file()</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>mailparse_msg_create()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


id: mailparse_msg_get_part
type: function
doc:
<comment>Description:</comment>
  Devuelve un gestor sobre una sección dada en un mensaje
    mime
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>     Un recurso <return>MIME</return> válido.
  <info>string</info>    <strong>$mimesection</strong>  

<comment>Return:</comment>
  <info>resource</info>  


id: mailparse_msg_get_part_data
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz asociativa de información sobre el
    mensaje
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Un recurso <return>MIME</return> válido.

<comment>Return:</comment>
  <info>array</info>  


id: mailparse_msg_get_structure
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz de nombres de sección mime en el mensaje
    dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Un recurso <return>MIME</return> válido.

<comment>Return:</comment>
  <info>array</info>  


id: mailparse_msg_parse
type: function
doc:
<comment>Description:</comment>
  Procesar datos incrementalmente sobre un búfer
  
  Procesa datos incrementalmente al interior del recurso de correo mime entregado.
  
  Esta función le permite secuenciar porciones de un archivo en pedazos, en lugar de leer y
  procesarlo en su totalidad.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Un recurso <return>MIME</return> válido.
  <info>string</info>    <strong>$data</strong>      El último trozo de <strong>$data</strong> debe terminar con una nueva línea (<return>CRLF</return>); de lo
                       contrario, no se analizará la última línea del mensaje.

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


id: mailparse_msg_parse_file
type: function
doc:
<comment>Description:</comment>
  Procesa un archivo
  
  Procesa un archivo. Este es el modo óptimo de interpretar un archivo que tenga en disco.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta al archivo que contiene el mensaje. El archivo es abierto y secuenciado a
                     través del analizador sintáctico.
                     
                     El mensaje contenido en <strong>$filename</strong> debe terminar con una nueva línea (<return>CRLF</return>); de
                     lo contrario, no se analizará la última línea del mensaje.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un recurso <return>MIME</return> que representa la estructura, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_create()</strong>


id: mailparse_rfc822_parse_addresses
type: function
doc:
<comment>Description:</comment>
  Procesa direcciones compatibles con RFC 822
  
  Procesa una lista de recipientes compatible con RFC 822, tal como la que es encontrada en una
  cabecera <return>To:</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$addresses</strong>  Una cadena que contiene direcciones, como: <return>Wez Furlong \<wez@example.com&gt;, pepe@example.com</return>
                      
                      Esta cadena no debe contener el nombre de la cabecera.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz de matrices asociativas con las siguientes claves para cada recipiente:
         <return>display</return> El nombre del recipiente, para propósitos de muestra. Si esta parte no es definida
         para un recipiente, esta clave contendrá el mismo valor que <return>address</return>. <return>address</return>La dirección de
         correo electrónico<return>is_group</return><info>true</info> si el recipiente es un grupo de noticias, <info>false</info> de lo
         contrario.


id: mailparse_stream_encode
type: function
doc:
<comment>Description:</comment>
  Secuencia datos desde un apuntador de archivo, codifica y escribe a
     fp_destino
    
  
  Secuencia datos del apuntador de archivo fuente, aplica la <strong>$codificacion</strong> y escribe al apuntador de
  archivo de destino.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sourcefp</strong>  Un gestor de archivo válido. El archivo es secuenciado a través del
                       procesador.
  <info>resource</info>  <strong>$destfp</strong>    El gestor de archivo de destino, en el cual los datos codificados serán
                       escritos.
  <info>string</info>    <strong>$encoding</strong>  Una de las codificaciones de caracteres soportadas por el módulo mbstring.

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


id: mailparse_uudecode_all
type: function
doc:
<comment>Description:</comment>
  Procesa los datos desde un apuntador a archivo y extrae cada archivo
     embebido con codificación uu
    
  
  Lee los datos del apuntador de archivo dado y extrae cada archivo codificado mediante uuencode
  embebido en un archivo temporal.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  Un apuntador de archivo válido.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz de matrices asociativas, listando la información de cada archivo.
         <return>filename</return>Ruta al nombre de archivo temporal creado<return>origfilename</return>El nombre de archivo original,
         solo para partes codificadas mediante uuencode La primera entrada es el cuerpo del mensaje.
         Las siguientes son los archivos uuencode decodificados.


id: max
type: function
doc:
<comment>Description:</comment>
  Encontrar el valor más alto
  
  Si el primer y único parámetro es un array, <strong>max()</strong> devuelve el valor más alto de ese array. Si se
  proporcionan al menos dos parámetros, <strong>max()</strong> devuelve el mayor de estos valores.
  
  Los valores de diferentes tipos serán comparados utilizando las  reglas de comparación estándar.
  Por ejemplo, un <info>string</info> no numérico será comparado con un <info>integer</info> como si fuera <return>0</return>, aunque varios
  valores no numéricos de tipo <info>string</info> serán comparados alfanuméricamente. El valor real devuelto
  será del tipo original sin ninguna conversión aplicada.
  
  Tenga cuidado al pasar argumentos con valores de tipos mezclados debido a que <strong>max()</strong> puede producir
  resultados impredecibles.

<comment>Param:</comment>
  <info>array</info>  <strong>$values</strong>  Un array que contiene los valores.
  <info>mixed</info>  <strong>$value1</strong>  Cualquier valor comparable.
  <info>mixed</info>  <strong>$value2</strong>  Cualquier valor comparable.
  <info>mixed</info>  <strong>$...</strong>     Cualquier valor comparable.

<comment>Return:</comment>
  <info>mixed</info>  <strong>max()</strong> devuelve el valor del parámetro considerado "el mayor" según las reglas de
         comparación estándar. Si varios valores de diferentes tipos se evalúan como iguales (p.ej.
         <return>0</return> y <return>'abc'</return>), será devuelto el primero proporcionado a la función.
         
         Si se pasa un array vacío, se devolverá <info>false</info> y se emitirá un error <info>E_WARNING</info>.

<comment>See Also:</comment>
   * <strong>min()</strong>
   * <strong>count()</strong>


id: mb_check_encoding
type: function
doc:
<comment>Description:</comment>
  Comprueba si el string es válido para a la codificación especificada
  
  Comprueba si el flujo de bytes especificado es válido para a la codificación especificada. Resulta
  de utilidad para prevenir el conocido "Ataque de Codificación Inválida".

<comment>Param:</comment>
  <info>string</info>  <strong>$var</strong>       El flujo de bytes a comprobar. Si se omite, esta función comprueba todos los
                     datos de entrada desde el comienzo de la petición.
  <info>string</info>  <strong>$encoding</strong>  La codificación a comprobar.

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


id: mb_chr
type: function
doc:
<comment>Description:</comment>
  Return character by Unicode code point value
  
  Returns a string containing the character specified by the Unicode code point value, encoded in
  the specified encoding.
  
  This function complements <strong>mb_ord()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$codepoint</strong>  A Unicode codepoint value, e.g. <return>128024</return> for U+1F418 ELEPHANT
  <info>string|null</info>  <strong>$encoding</strong>   El parámetro <strong>$encoding</strong>
                           es la codificación de caracteres. Si es omitido, será usado el valor de
                           la
                           codificación de caracteres interna.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the requested character, if it can be represented in the
                specified encoding  o <info>false</info> en caso de error.

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


id: mb_convert_case
type: function
doc:
<comment>Description:</comment>
  Realiza una conversión a mayúsculas/minúsculas de un string
  
  Realiza una conversión a mayúsculas/minúsculas en un <info>string</info>, de acuerdo al modo especificado por
  <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> que se va a convertir.
  <info>int</info>     <strong>$mode</strong>      El modo de conversión. Puede ser <info>MB_CASE_UPPER</info>,  <info>MB_CASE_LOWER</info>, o
                     <info>MB_CASE_TITLE</info>.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  La versión convertida del <strong>$string</strong> tal como se especificó en el parámetro <strong>$mode</strong>.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>


id: mb_convert_encoding
type: function
doc:
<comment>Description:</comment>
  Convierte una codificación de caracteres
  
  Convierte la codificación de caracteres del <info>string</info> <strong>$str</strong> a la especificada por <strong>$to_encoding</strong>,
  indicando opcionalmente la codificación de caracteres inicial en <strong>$from_encoding</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>            El <info>string</info> a codificar.
  <info>string</info>  <strong>$to_encoding</strong>    El tipo de codificación a la que convertir <strong>$str</strong>.
  <info>mixed</info>   <strong>$from_encoding</strong>  Se especifica por los nombres de los códigos de caracteres previos a la
                          conversión. Se trata de, o bien un <info>array</info>, o bien de una lista separada por
                          comas. Si no se especificara ningún valor para <strong>$from_encoding</strong>, se
                          utilizará la codificación interna.
                          
                          Revise las codificaciones admitidas.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> codificado.

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


id: mb_convert_kana
type: function
doc:
<comment>Description:</comment>
  Convierte un "kana" a otro ("zen-kaku", "han-kaku" y más)
  
  Realiza una conversión "han-kaku" - "zen-kaku" en el <info>string</info> <strong>$str</strong>. Esta función solo es útil para
  el idioma japonés.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a convertir.
  <info>string</info>  <strong>$option</strong>    La opción de conversión.
                     
                     Se especifica con una combinación de las siguientes opciones. Opciones de
                     conversión posiblesOpciónSignificado<return>r</return> Convierte los alfabetos "zen-kaku" a
                     "han-kaku" <return>R</return> Convierte los alfabetos "han-kaku" a "zen-kaku" <return>n</return> Convierte los
                     números "zen-kaku" a "han-kaku" <return>N</return> Convierte los números "han-kaku" a "zen-kaku"
                     <return>a</return> Convierte los alfabetos y los números "zen-kaku" a "han-kaku" <return>A</return> Convierte los
                     alfabetos y los números "han-kaku" a "zen-kaku" (Los caracteres incluídos en
                     las opciones "a" y "A" están en el rango U+0021 - U+007E excepto U+0022,
                     U+0027, U+005C, U+007E) <return>s</return> Convierte del espacio de "zen-kaku" al de "han-kaku"
                     (U+3000 -&gt; U+0020) <return>S</return> Convierte del espacio de "han-kaku" al de "zen-kaku"
                     (U+0020 -&gt; U+3000) <return>k</return> Convierte "zen-kaku kata-kana" a "han-kaku kata-kana" <return>K</return>
                     Convierte "han-kaku kata-kana" a "zen-kaku kata-kana" <return>h</return> Convierte "zen-kaku
                     hira-gana" a "han-kaku kata-kana" <return>H</return> Convierte "han-kaku kata-kana" a "zen-kaku
                     hira-gana" <return>c</return> Convierte "zen-kaku kata-kana" a "zen-kaku hira-gana" <return>C</return> Convierte
                     "zen-kaku hira-gana" a "zen-kaku kata-kana" <return>V</return> Colapsa la notación de sonidos de
                     voz, y la converte a caracteres. Usar con "K","H"
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> convertido.


id: mb_convert_variables
type: function
doc:
<comment>Description:</comment>
  Convierte códigos de caracteres a variable/s
  
  Convierta  codificaciones de caracteresa de <strong>$vars</strong> variables de la codificación <strong>$from_encoding</strong> a la
  codificación <strong>$to_encoding</strong>.
  
  <strong>mb_convert_variables()</strong> une cadenas de caracteres en un Array u Object para detectar la
  codificación, ya que la detección de codificaciones tiene a falla si las cadenas de caracteres son
  cortas. Por lo tanto, es imposible mezclar codificaciones en un único array u objeto.

<comment>Param:</comment>
  <info>string</info>  <strong>$to_encoding</strong>    La codificación a la que se va a convertir <info>string</info>.
  <info>mixed</info>   <strong>$from_encoding</strong>  <strong>$from_encoding</strong> se especifica mediante un <info>array</info>  o <info>string</info> separado por
                          comas, e intenta detectar la codificación desde <strong>$from-coding</strong>. Cuando
                          <strong>$from_encoding</strong>  se omite, se utiliza <return>detect_order</return>.
  <info>mixed</info>   <strong>$vars</strong>           <strong>$vars</strong> es la referencia a la variable que va a ser convertida. Se aceptan
                          String, Array y Object. <strong>mb_convert_variables()</strong> asume que todos los
                          parámetros tienen la misma codificación.
  <info>mixed</info>   <strong>$...</strong>            <strong>$vars</strong> adicionales.

<comment>Return:</comment>
  <info>string</info>  La codificación de caracteres antes de la conversión en caso de éxito, o <info>false</info> en caso de
          error.


id: mb_decode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Decodifica un string en el campo de cabecera MIME
  
  Decodifica el <info>string</info> codificado por palabras <strong>$str</strong> en cabecera MIME.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  El <info>string</info> a decodificar.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> decodificado en la codificación de caracteres interna.

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


id: mb_decode_numericentity
type: function
doc:
<comment>Description:</comment>
  Decodifica referencias a string numéricas de HTML en caracteres
  
  Convierte las referencias a string numéricas del <info>string</info> <strong>$str</strong> en un bloque de caracteres
  especificado.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a decodificar.
  <info>array</info>   <strong>$convmap</strong>   <strong>$convmap</strong> es un <info>array</info> que especifica el área de código a convertir.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> convertido.

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


id: mb_detect_encoding
type: function
doc:
<comment>Description:</comment>
  Detecta la codificación de caracteres
  
  Detecta la codificación de caracteres del <info>string</info> <strong>$str</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>            El <info>string</info> en el que detectar la codificación.
  <info>mixed</info>   <strong>$encoding_list</strong>  <strong>$encoding_list</strong> es una lista de codificaciones de caracteres. El orden de
                          codificaciones puede ser especificado por un array o una lista de string
                          separados por comas.
                          
                          Si se omite <strong>$encoding_list</strong>, se usará detect_order.
  <info>bool</info>    <strong>$strict</strong>         <strong>$strict</strong> especifica si usar la detección de codificación estricta o no. El
                          valor predeterminado es <info>false</info>.

<comment>Return:</comment>
  <info>string</info>  La codificación de caracteres detectada, o <info>false</info> si la codificación no se pudo detectar en
          el string dado.

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


id: mb_detect_order
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene el orden de detección de codificaciones de caracteres
  
  Establece el orden de detección automática de la codificación de caracteres a <strong>$encoding_list</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$encoding_list</strong>  <strong>$encoding_list</strong> es un <info>array</info> o una lista de codificaciones de caracteres
                         separadas por comas. Véanse las codificaciones admitidas.
                         
                         Si se omite <strong>$encoding_list</strong>, devolverá el orden actual de detección de las
                         codificaciones de caracteres como un array.
                         
                         Este parámetro afecta a <strong>mb_detect_encoding()</strong> y a <strong>mb_send_mail()</strong>.
                         
                         <return>mbstring</return> actualmente implementa los siguientes filtros de detección de
                         codificaciones. Si existiera una secuencia de bytes inválida para las
                         siguientes codificaciones, la detección de la codificación fallará.
                         
                         <return>UTF-8</return>, <return>UTF-7</return>, <return>ASCII</return>, <return>EUC-JP</return>,<return>SJIS</return>, <return>eucJP-win</return>, <return>SJIS-win</return>, <return>JIS</return>, <return>ISO-2022-JP</return>
                         
                         Para <return>ISO-8859-*</return>, <return>mbstring</return> siempre lo detecta como <return>ISO-8859-*</return>.
                         
                         Para <return>UTF-16</return>, <return>UTF-32</return>, <return>UCS2</return> y <return>UCS4</return>, la detección de la codificación siempre
                         fallará.

<comment>Return:</comment>
  <info>mixed</info>  Al establecer el orden de detección de codificación, se devuelve <info>true</info> en caso de éxito o
         <info>false</info> en caso de fallo.
         
         Al obtener el orden de detección de codificación, se devuelve un array ordenado con las
         codificaciones.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_send_mail()</strong>


id: mb_encode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Codifica un string para la cabecera MIME
  
  Codifica el <info>string</info> <strong>$str</strong> dado mediante el esquema de codificación de cabecera MIME.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>                El <info>string</info> que va a ser codificado. Su codificación debería ser la
                              misma que <strong>mb_internal_encoding()</strong>.
  <info>string</info>  <strong>$charset</strong>            <strong>$charset</strong> especifica el nombre del conjunto de caracteres en el cual
                              está representado <strong>$str</strong>. El valor predeterminado está determinado por
                              el ajuste NLS en uso (<return>mbstring.language</return>).
  <info>string</info>  <strong>$transfer_encoding</strong>  <strong>$transfer_encoding</strong> especifica el esquema de la codifición MIME.
                              Debería ser <return>"B"</return> (Base64) o <return>"Q"</return> (Quoted-Printable). Si no ser
                              proporciona será <return>"B"</return>.
  <info>string</info>  <strong>$linefeed</strong>           <strong>$linefeed</strong> especifica la marca EOL (fin de línea) con la que
                              <strong>mb_encode_mimeheader()</strong> realiza el pliegue de línea (un término de RFC,
                              que es el acto de dividir una línea mayor que una cierta longitud en
                              varias líneas. La longitud actualmente es de 74 caracteres). Si no se
                              proporciona será <return>"\r\n"</return> (CRLF).
  <info>int</info>     <strong>$indent</strong>             La indentación de la primera línea (número de caracteres en la
                              cabecera antes de <strong>$str</strong>).

<comment>Return:</comment>
  <info>string</info>  Una versión convertida del <info>string</info> representado en ASCII.

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


id: mb_encode_numericentity
type: function
doc:
<comment>Description:</comment>
  Convierte caracteres a referencias de string numéricas de HTML
  
  Convierte los códigos de caracteres especificados en el <info>string</info> <strong>$str</strong> desde un código de caracter a
  un referencia de carácter numérico de HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a ser codificado.
  <info>array</info>   <strong>$convmap</strong>   <strong>$convmap</strong> es un array que especifica el área de código a convertir.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.
  <info>bool</info>    <strong>$is_hex</strong>    

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> convertido.

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


id: mb_encoding_aliases
type: function
doc:
<comment>Description:</comment>
  Obtiene los alias de un tipo de codificación conocido
  
  Devuelve un array con los alias de un tipo de codificación conocido dado por <strong>$encoding</strong> type.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  El tipo de codificación del cual se quieren obtener los alias.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array indexado numéricamente con los alias de la condificación en caso de
         éxito, o <info>false</info> en caso de error

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


id: mb_ereg
type: function
doc:
<comment>Description:</comment>
  Comparación de expresiones regulares con soporte multibyte
  
  Ejecuta la comparación de expresiones regulares con soporte multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de búsqueda.
  <info>string</info>  <strong>$string</strong>   El <info>string</info> de búsqueda.
  <info>array</info>   <strong>$regs</strong>     Contiene un substring del <info>string</info> comparado.

<comment>Return:</comment>
  <info>int</info>  Ejecuta la comparación de expresiones regulares con soporte multibyte, y devuelve <return>1</return> si se
       encontraron coincidencias. Si se especificó el parámetro opcional <strong>$regs</strong>, la función devolverá
       la longitud en bytes de la parte comparada, y el <info>array</info> <strong>$regs</strong> contendrá el substring del
       string comparado. La función devuelve <return>1</return> si coincide con el string vacío. Si no se encontraron
       coincidencias u ocurrió un error, devolverá <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi()</strong>


id: mb_ereg_match
type: function
doc:
<comment>Description:</comment>
  Compararción de expresiones regulares para strings multibyte
  
  Una compararción de expresiones regulares para strings multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de la expresión regular.
  <info>string</info>  <strong>$string</strong>   El <info>string</info> a ser evaluado.
  <info>string</info>  <strong>$option</strong>   

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$string</strong> coincide con la expresión regular <strong>$pattern</strong>, <info>false</info> si no.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_ereg_replace
type: function
doc:
<comment>Description:</comment>
  Reemplaza una expresión regular con soporte multibyte
  
  Explora <strong>$string</strong> para ver si hay coincidencias con <strong>$pattern</strong>, luego reemplaza el texto coincidente
  con <strong>$replacement</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>      El patrón de la expresión regular.
                        
                        Se pueden usar caracteres multibyte en <strong>$pattern</strong>.
  <info>string</info>  <strong>$replacement</strong>  El texto de sustitución.
  <info>string</info>  <strong>$string</strong>       El <info>string</info> que va a ser comprobado.
  <info>string</info>  <strong>$option</strong>       Las condiciones de comparación se pueden establecer con el parámetro
                        <strong>$option</strong>. Si se especifica <return>i</return> para este parámetro, no se diferenciará entre
                        mayúsculas/minúsculas. Si se especifica <return>x</return>, se ignorarán los espacios en
                        blanco. Si se especifica <return>m</return>, la comparación se ejecutará en modo multilínea y
                        los saltos de línea estarán incluidos en '.'. Si se especifica <return>p</return>, la
                        compararción se ejecutará en modo POSIX, los saltos de línea serán
                        considerados como caracteres normales. Si se especifica <return>e</return>, el string
                        <strong>$replacement</strong> será evaluado como una expresión de PHP.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> resultante en caso de éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi_replace()</strong>


id: mb_ereg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Realiza una búsqueda y sustitución de una expresión regular con soporte multibyte usando una
  llamada
  de retorno
    
  
  Examina <strong>$string</strong> para buscar coincidencias con <strong>$pattern</strong>, luego reemplaza el texto coincidente con
  la salida de la función <strong>$callback</strong>.
  
  El comportamiento de esta función es casi idéntico al de <strong>mb_ereg_replace()</strong>, excepto que en lugar
  del parámetro <strong>$replacement</strong>, se debería especificar una llamada de retorno dada por <strong>$callback</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$pattern</strong>   El patrón de la expresión regular.
                       
                       Se pueden usar caracteres multibyes en <strong>$pattern</strong>.
  <info>callable</info>  <strong>$callback</strong>  Una llamada de retorno que será invocada y se le proporcionará un array de
                       elementos coincidentes en el string  <strong>$subject</strong>. La llamada de retorno debería
                       devolver el string de sustitución.
                       
                       A menudo será necearia la función <strong>$callback</strong> para una
                       <strong>mb_ereg_replace_callback()</strong> en un sólo lugar. En este caso se puede usar una
                       función anónima para declarar una llamada de retorno dentro de la llamada a
                       <strong>mb_ereg_replace_callback()</strong>. De esta manera se tendrá toda la información para
                       la llamada en un lugar para no abarrotar el espacion de nombres de funciones
                       con un nombre de de una función de llamada de retorno que no se usará.
  <info>string</info>    <strong>$string</strong>    El <info>string</info> a comprobar.
  <info>string</info>    <strong>$option</strong>    Las condiciones de comparación se pueden establecer por el parámetro <strong>$option</strong>.
                       Si se especifica <return>i</return> para este parámetro, no se tendrán en cuenta las
                       mayúsculas/minúsculas. Si se especifica <return>x</return>, se ingorarán los espacios en
                       blanco. Si se especifica <return>m</return>, la comparación se ejecutará en modo multilínea y
                       se incluirán los saltos de línea en '.'. Si se especifica <return>p</return>, la comparación
                       se ejecutará en modo POSIX, por lo que los saltos de línea se cosiderarán
                       como caracteres normales. Observe que <return>e</return> no se puede usar en
                       <strong>mb_ereg_replace_callback()</strong>.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> resultante en caso de éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>
   * Funciones anónimas


id: mb_ereg_search
type: function
doc:
<comment>Description:</comment>
  Comparación de expresiones regulares multibyte para un string multibyte predefinido
  
  Realiza una compararción de una expresión regular multibyte para un string multibyte predefinido.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de búsqueda.
  <info>string</info>  <strong>$option</strong>   La opción de búsqueda.

<comment>Return:</comment>
  <info>bool</info>  <strong>mb_ereg_search()</strong> devuelve <info>true</info> si el string multibyte coinciden con la expresión regular, o
        <info>false</info> si no. El <info>string</info> para la comparación se establece mediante <strong>mb_ereg_search_init()</strong>. Si
        no se especifica <strong>$pattern</strong>, se usará el patrón utilizado anteriormente.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_getpos
type: function
doc:
<comment>Description:</comment>
  Devuelve la posición de inicio para la siguiente comparación de una expresión regular
  
  Devuelve la posición de inicio para la siguiente coincidencia de una expresión regular.

<comment>Return:</comment>
  <info>int</info>  <strong>mb_ereg_search_getpos()</strong> devuelve el punto de inicio de la comparación de una expresión
       regular para <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. La posición está
       representada mediante bytes desde la cabeza del string.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_setpos()</strong>


id: mb_ereg_search_getregs
type: function
doc:
<comment>Description:</comment>
  Recupera el resultado de la última comparación de expresión regular multibyte
  
  Recupera el resultado de la última comparación de expresión regular multibyte.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que incluye el substring de la parte coincidente mediante la última llamada a
         <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. Si existieran algunas
         coincidencias, el primer elemento contendrá el substring coincidente, el segundo elemento
         contendrá el primer agrupamiento entre paréntesis, el tercer elemento contendrá el segundo
         agrupamiento entre paréntesis, etc. Devuelve <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_init
type: function
doc:
<comment>Description:</comment>
  Configura el string y la expresión regular para una comparación de expresiones regulares multibyte
  
  <strong>mb_ereg_search_init()</strong> establece <strong>$string</strong> y <strong>$pattern</strong> para una expresión regular multibyte. Estos
  valores se usan para <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, y <strong>mb_ereg_search_regs()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>   El estring de búsquda.
  <info>string</info>  <strong>$pattern</strong>  El patrón de búsqueda.
  <info>string</info>  <strong>$option</strong>   La opción de búsqueda.

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


id: mb_ereg_search_pos
type: function
doc:
<comment>Description:</comment>
  Devuelve la posición y la longitud de una parte coincidente de la expresión regular multibyte para
  un string multibyte predefinido
  
  Devuelve la posición y la longitud de una parte coincidente de la expresión regular multibyte para
  un string multibyte predefinido.
  
  El string para la comparación se especifica mediante <strong>mb_ereg_search_init()</strong>. Si no se especifica,
  se usará el utilizado anteriormente.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de búsqueda.
  <info>string</info>  <strong>$option</strong>   La opción de búsqueda.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contiene dos elementos. El primero es el índice, en bytes, donde la
         coincidencia es relativa al inicio del string de búsqueda, y el segundo elemento es la
         longitud de la coincidencia.
         
         Si ocurre un error, devuelve <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_regs
type: function
doc:
<comment>Description:</comment>
  Devuelve la parte coincidente de una expresión regular multibyte
  
  Devuelve la parte coincidente de una expresión regular multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de búsqueda.
  <info>string</info>  <strong>$option</strong>   La opción de búsqueda.

<comment>Return:</comment>
  <info>array</info>  <strong>mb_ereg_search_regs()</strong> ejecuta la comparación de la expresión regular multibyte, y si existe
         alguna parte coincidente, devuelve un <info>array</info> que incluye el substring de la parte
         coincidente como primer elemento, la primera parte agrupada entre paréntesis como segundo
         elemento, la segunda parte agrupada entre paréntesis como tercer elemento, etc. Devuelve
         <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_setpos
type: function
doc:
<comment>Description:</comment>
  Establece el punto de inicio de la siguiente comparación de una expresión regular
  
  <strong>mb_ereg_search_setpos()</strong> establece el punto de inicio de una comparación con <strong>mb_ereg_search()</strong>.

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

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


id: mb_eregi
type: function
doc:
<comment>Description:</comment>
  Comparación de expresiones regulares ignorando mayúsculas/minúsculas con soporte multibyte
  
  Ejecuta la comparación de expresiones regulares insensible a mayúsculas/minúsculas con soporte
  multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de la expresión regular.
  <info>string</info>  <strong>$string</strong>   El <info>string</info> donde buscar.
  <info>array</info>   <strong>$regs</strong>     Contiene un substring del <info>string</info> comparado.

<comment>Return:</comment>
  <info>int</info>  Ejecuta la comparación de expresiones regulares con soporte multibyte, y devuelve <return>1</return> si se
       encontraron coincidencias. Si se especificó el parámetro opcional <strong>$regs</strong>, la función devolverá
       la longitud en bytes de la parte comparada, y el <info>array</info> <strong>$regs</strong> contendrá el substring del
       string comparado. La función devuelve <return>1</return> si coincide con el string vacío. Si no se encontraron
       coincidencias u ocurrió un error, devolverá <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_eregi_replace
type: function
doc:
<comment>Description:</comment>
  Reemplaza una expresión regular con soporte multibyte ignorando mayúsculas/minúsculas
  
  Explora <strong>$string</strong> para ver si hay coincidencias con <strong>$pattern</strong>, luego reemplaza el texto coincidente
  con <strong>$replacement</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de la expresión regular. Se pueden usar caracteres multibyte. Se
                    ignorará la distinción entre mayúsculas/minúsculas.
  <info>string</info>  <strong>$replace</strong>  El texto de sustitución.
  <info>string</info>  <strong>$string</strong>   El <info>string</info> buscado.
  <info>string</info>  <strong>$option</strong>   <strong>$option</strong> tiene el mismo significado que en <strong>mb_ereg_replace()</strong>.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> resultante o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>


id: mb_get_info
type: function
doc:
<comment>Description:</comment>
  Obtiene la configuración interna de mbstring
  
  <strong>mb_get_info()</strong> devuelve los parámetros de configuración interna de mbstring.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Si no se estecifica <strong>$type</strong> o si se especifica como "all", será devuelto un <info>array</info> con
                 los elementos "internal_encoding", "http_output", "http_input", "func_overload",
                 "mail_charset", "mail_header_encoding", "mail_body_encoding".
                 
                 Si <strong>$type</strong> se especifica como "http_output", "http_input", "internal_encoding",
                 "func_overload", será devuelto el parámetro de configuración especificado.

<comment>Return:</comment>
  <info>mixed</info>  Un <info>array</info> con el tipo de información si <strong>$type</strong>  no se especifica, o de otro modo, el <strong>$type</strong>
         especificado.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_http_output()</strong>


id: mb_http_input
type: function
doc:
<comment>Description:</comment>
  Detecta la codificación de caracteres de entrada HTTP
  
  Detecta la codificación de caracteres de entrada HTTP.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Un string de entrada que especifica el tipo de entrada. "G" para GET, "P" para
                 POST, "C" para COOKIE, "S" para string, "L" para una lista, y "I" para una lista
                 completa (devolverá un <info>array</info>).  Si se omite el tipo, devolverá el último tipo de
                 entrada procesado.

<comment>Return:</comment>
  <info>mixed</info>  El nombre de la codificación de caracteres, según <strong>$type</strong>. Si <strong>mb_http_input()</strong> no procesa la
         entrada HTTP especificada, devolverá <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_http_output
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene la codificación de caracteres de salida HTTP
  
  Establece/obtiene la codificación de caracteres de salida HTTP. La salida después de llamar a esta
  función será convertida de la codificación interna a <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  Si se establece <strong>$encoding</strong>, <strong>mb_http_output()</strong> establece la codificación de
                     caracteres de salida HTTP a <strong>$encoding</strong>.
                     
                     Si se omite <strong>$encoding</strong>, <strong>mb_http_output()</strong> devolverá la codificación de caracteres
                     de salida HTTP en uso.

<comment>Return:</comment>
  <info>mixed</info>  Si <strong>$encoding</strong> se omite, <strong>mb_http_output()</strong> devuelve la codificación de caracteres de salida
         HTTP en uso. De otro modo, Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_internal_encoding
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene la codificación de caracteres interna
  
  Establece/obtiene la codificación de caracteres interna.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  <strong>$encoding</strong> es el nombre de la codificación de caracteres usada para la
                     conversión de la codificación de caracteres de entrada HTTP, la conversión de
                     la codificación de caracteres de salida HTTP , y la codificación de caracteres
                     predeterminada para funciones de cadenas de caracteres definidas por el módulo
                     mbstring. Debería observarse que la codificación interna es totalmente
                     diferente de la de la expresión regular multibyte.

<comment>Return:</comment>
  <info>mixed</info>  Si se establece <strong>$encoding</strong>, entonces Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de
         error. En este caso, la codificación de caracteres para expresiones regulares multibyte NO
         se cambia. Si se omite <strong>$encoding</strong>, entonces  devolverá el nombre de la codificación de
         caracteres en uso.

<comment>See Also:</comment>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_regex_encoding()</strong>


id: mb_language
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene el idioma actual
  
  Establece/obtiene el idioma actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Se usa para codificar mensajes de correo electrónico. Los idiomas válidos son
                     "Japanese", "ja","English","en" y "uni" (UTF-8). <strong>mb_send_mail()</strong> utiliza este
                     ajuste para codificar correos electrónicos.
                     
                     El idiomma y su configuración está en ISO-2022-JP/Base64 para Japanese,
                     UTF-8/Base64 para uni, ISO-8859-1/quoted printable para English.

<comment>Return:</comment>
  <info>mixed</info>  Si se establece <strong>$language</strong> y <strong>$language</strong> es válido, devuelve <info>true</info>. De lo contrario devuelve
         <info>false</info>.  Cuando se omite <strong>$language</strong>, devuelve el nombre del idioma como <info>string</info>. Si no se
         había establecido ningún idioma anteriormente, entonces devuelve <info>false</info>.

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


id: mb_list_encodings
type: function
doc:
<comment>Description:</comment>
  Devuelve un array con todos los tipos de codificaciones admitidas
  
  Devuelve un array con todos los tipos de codificaciones admitidas.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array indexado numéricamente.


id: mb_ord
type: function
doc:
<comment>Description:</comment>
  Get Unicode code point of character
  
  Returns the Unicode code point value of the given character.
  
  This function complements <strong>mb_chr()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A string
  <info>string|null</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                          es la codificación de caracteres. Si es omitido, será usado el valor de la
                          codificación de caracteres interna.

<comment>Return:</comment>
  <info>int|false</info>  The Unicode code point for the first character of <return>string</return>  o <info>false</info> en caso de error.

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


id: mb_output_handler
type: function
doc:
<comment>Description:</comment>
  Función de llamada de retorno que convierte la codificación de caracteres en búfer de salida
  
  <strong>mb_output_handler()</strong> es una función de llamada de retorno de <strong>ob_start()</strong>. <strong>mb_output_handler()</strong>
  convierte los carateres en el búfer de salida de la condificación de caracteres interna a la
  codificación de caracteres de salida HTTP.

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  El contenido del búfer de salida.
  <info>int</info>     <strong>$status</strong>    El estado del búfer de salida.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> convertido.

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


id: mb_parse_str
type: function
doc:
<comment>Description:</comment>
  Analiza datos GET/POST/COOKIE y establece varialbes globales
  
  Analiza datos GET/POST/COOKIE y establece variables globales. Ya que PHP no proporciona datos
  POST/COOKIE sin tratar, solamente se puede usar para datos GET por ahora. Analiza los datos del
  URL codificado, detecta la codificación, convierte la codificación a la codificación interna y
  establece los valores del <info>array</info>  <strong>$result</strong> o de las variables globales.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoded_string</strong>  Los datos del URL codificado.
  <info>array</info>   <strong>$result</strong>          Un <info>array</info> que contiene la decodificación y los valores convertidos de la
                           codificación de caracteres.

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


id: mb_preferred_mime_name
type: function
doc:
<comment>Description:</comment>
  Obtener un string del conjunto de caracteres del MIME
  
  Obtiene un <info>string</info> del conjunto de caracteres del MIME para una codificación específica.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  La codificación que va a ser comprobada.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> del <return>conjunto de caracteres</return> del MIME para la codificación de caracteres dada por
          <strong>$encoding</strong>.


id: mb_regex_encoding
type: function
doc:
<comment>Description:</comment>
  Establecer/obtener la codificación de caracteres para expresiones regulares multibyte
  
  Establece/obtiene la codificación de caracteres para una expresión regular multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>mixed</info>  Si se establece <strong>$encoding</strong>, entonces Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de
         error. En este caso, la codificación de caracteres interna NO se cambia. Si se omite
         <strong>$encoding</strong>, entonces devolverá el nombre de la codificación de caracteres en uso para una
         expresión regular multibyte.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_regex_set_options
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene las opciones predeterminadas para las funciones mbregex
  
  Establece las opciones predeterminadas descritas por <strong>$options</strong>  para las funciones de expresiones
  regulares multibyte.

<comment>Param:</comment>
  <info>string</info>  <strong>$options</strong>  Las opciones a establecer. Es un estring donde cada carácter es una opción. Para
                    establecer un modo, el carácter de dicho modo debe ser el último en
                    establecerse, ya que solamente puede ser establecdio un modo, aunque múltiples
                    opciones.

<comment>Return:</comment>
  <info>string</info>  Las opciones anteriores. Si se omite <strong>$options</strong>,  devuelve el <info>string</info> que describe las
          opciones actuales.

<comment>See Also:</comment>
   * <strong>mb_split()</strong>
   * <strong>mb_ereg()</strong>
   * <strong>mb_eregi()</strong>


id: mb_scrub
type: function
doc:
<comment>Description:</comment>
  Replace ill-formed byte sequences with the substitute character
  
  Perform a character set conversion from the specified encoding, or the default encoding if no
  encoding was specified, to the same encoding. This has the effect of replacing any invalid byte
  sequences with the substitute character.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The input string.
  <info>string|null</info>  <strong>$encoding</strong>  The encoding used to interpret <strong>$string</strong>. If it is omitted or <info>null</info>, the
                          mbstring.internal_encoding setting will be used if set, otherwise the
                          default_charset setting will be used.

<comment>Return:</comment>
  <info>string</info>  The <info>string</info> result with invalid byte sequences replaced.


id: mb_send_mail
type: function
doc:
<comment>Description:</comment>
  Envía un correo codificado
  
  Envía un correo. Las cabeceras y los mensajes se convierten y se codifican de acuerdo al ajuste
  <strong>mb_language()</strong>. Es una función de envoltura para <strong>mail()</strong>. Véase también <strong>mail()</strong> para más detalles.

<comment>Param:</comment>
  <info>string</info>  <strong>$to</strong>                    La dirección de envío del correo. Se pueden especificar múltiples
                                 destinatarios poniendo una coma entre cada dirección de <strong>$to</strong>.  Este
                                 parámetro no se codifica de forma automática.
  <info>string</info>  <strong>$subject</strong>               El asunto del correo.
  <info>string</info>  <strong>$message</strong>               El mensaje del correo.
  <info>string</info>  <strong>$additional_headers</strong>    El string a insertar al final de la cabecera del email.
                                 
                                 Por lo común, se usa para añadir cabeceras extra (From, Cc, y Bcc).
                                 Múltiples cabeceras deberían separarse con un CRLF (\r\n). Se ha de
                                 validar este parámetro para evitar la inyección de cabeceras no
                                 deseadas.
                                 
                                 Al enviar un correo, éste debe contener una cabecera <return>From</return>. Ésta se
                                 puede estabelcer con el  parámetro <strong>$additional_headers</strong>, o se puede
                                 establecer una predeterminada en php.ini.
                                 
                                 La omisión de dicha cabecera resultará en un mensaje de error
                                 similar a <return>Warning: mail(): "sendmail_from" not set in php.ini or
                                 custom "From:" header missing</return>. La cabecera <return>From</return> establece también
                                 <return>Return-Path</return> bajo Windows.
                                 
                                 Si los mensajes no se reciben, intente usar LF (\n) solamente.
                                 Algunos agengtes de transferencia de correo de Unix (más en
                                 concreto qmail) reemplazan LF por CRLF automáticamente (lo que
                                 conduce a doblar CR si se usa CRLF). Esto debería ser el último
                                 recurso, ya que no cumple con la RFC 2822.
  <info>string</info>  <strong>$additional_parameter</strong>  <strong>$additional_parameter</strong> es un parámetro de línea de comandos MTA. Es
                                 útil al establecer la cabecera Return-Path correcta cuando se usa
                                 sendmail.
                                 
                                 Este parámetro es escapado por <strong>escapeshellcmd()</strong> internamente para
                                 evitar la ejecución de comandos. <strong>escapeshellcmd()</strong> evita la
                                 ejecución de comandos, peros permite añadir parámetros adicionales.
                                 Por motivos de seguridad, este parámetro debería ser validado.
                                 
                                 Ya que <strong>escapeshellcmd()</strong> se aplica automáticamente, no se pueden
                                 usar algunos caracteres que están permitidos como direcciones de
                                 email por las RFC. Los programas que necesiten usar estos caracters
                                 no podrán utilizar <strong>mail()</strong>.
                                 
                                 El usuario con el que se ejecute el servidor web debería añadirso
                                 como usuario de confianza a la configuración de sendmail para
                                 evitar que se añada una cabecera 'X-Warning' al mensaje cuando se
                                 establezca el remitente (-f) usando este método. Para usuarios de
                                 sendmail, este fichero es /etc/mail/trusted-users.

<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>mail()</strong>
   * <strong>mb_encode_mimeheader()</strong>
   * <strong>mb_language()</strong>


id: mb_split
type: function
doc:
<comment>Description:</comment>
  Divide cadenas de caracteres multibyte usando una expresión regular
  
  Divide un <strong>$string</strong> multibyte usando la expresión regular <strong>$pattern</strong> y devolviendo el resultado como
  un <info>array</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  El patrón de la expresión regular.
  <info>string</info>  <strong>$string</strong>   El <info>string</info> que va a ser dividido.
  <info>int</info>     <strong>$limit</strong>    Si se especifica el parámetro opcional <strong>$limit</strong>,  la división será de <strong>$limit</strong>
                    elementos como máximo.

<comment>Return:</comment>
  <info>array</info>  El resultado como <info>array</info>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_str_pad
type: function
doc:
<comment>Description:</comment>
  Pad a multibyte string to a certain length with another multibyte string
  
  This function returns the <strong>$string</strong> padded on the left, the right, or both sides to the specified
  padding length, where the length is measured in Unicode codepoints. If the optional argument
  <strong>$pad_string</strong> is not supplied, the <strong>$string</strong> is padded with spaces, otherwise it is padded with
  characters from <strong>$pad_string</strong> up to the limit.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      The input string.
  <info>int</info>          <strong>$length</strong>      If the value of <strong>$length</strong> is negative, less than, or equal to the length
                            of the input string, no padding takes place, and <strong>$string</strong> will be
                            returned.
  <info>string</info>       <strong>$pad_string</strong>  The <strong>$pad_string</strong> may be truncated if the required number of padding
                            characters can't be evenly divided by the <strong>$pad_string</strong>'s length.
  <info>int</info>          <strong>$pad_type</strong>    Optional argument <strong>$pad_type</strong> can be <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>, or
                            <info>STR_PAD_BOTH</info>. By default <info>STR_PAD_RIGHT</info>.
  <info>string|null</info>  <strong>$encoding</strong>    El parámetro <strong>$encoding</strong>
                            es la codificación de caracteres. Si es omitido, será usado el valor de
                            la
                            codificación de caracteres interna.

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


id: mb_str_split
type: function
doc:
<comment>Description:</comment>
  Given a multibyte string, return an array of its characters
  
  This function will return an array of strings, it is a version of <strong>str_split()</strong> with support for
  encodings of variable character size as well as fixed-size encodings of 1,2 or 4 byte characters.
  If the <strong>$length</strong> parameter is specified, the string is broken down into chunks of the specified
  length in characters (not bytes). The <strong>$encoding</strong> parameter can be optionally specified and it is
  good practice to do so.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> to split into characters or chunks.
  <info>int</info>          <strong>$length</strong>    If specified, each element of the returned array will be composed of
                          multiple characters instead of a single character.
  <info>string|null</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                          es la codificación de caracteres. Si es omitido, será usado el valor de la
                          codificación de caracteres interna.
                          
                          A string specifying one of the supported encodings.

<comment>Return:</comment>
  <info>array</info>  <strong>mb_str_split()</strong> returns an array of strings.

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


id: mb_strcut
type: function
doc:
<comment>Description:</comment>
  Obtener parte de un string
  
  <strong>mb_strcut()</strong> extrae un substring de un string de forma similar a <strong>mb_substr()</strong>, pero opera sobre
  bytes en lugar de caracteres. Si la posición de corte ocurre entre dos bytes de un carácter
  multibyte, dicho corte se realiza empezando desde el primer byte del carácter. Esta es también la
  diferencia con la función <strong>substr()</strong>, la cual simplemente cortaría el string entre los bytes,
  resultando así una secuencia de bytes malformada.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a cortar.
  <info>int</info>     <strong>$start</strong>     Si <strong>$start</strong> no es negativo, el string devuelto comenzará en la posición del byte
                     <strong>$start</strong>-ésima de <strong>$string</strong>, empezando desde cero. Por ejemplo, en el string
                     '<return>abcdef</return>', el byte en la posición <return>0</return> es '<return>a</return>', el byte en la posición <return>2</return> es '<return>c</return>',
                     etc.
                     
                     Si <strong>$start</strong> es negative, el string devuelto comenzará en el byte <strong>$start</strong>-ésimo
                     desde el final de <strong>$string</strong>.
  <info>int</info>     <strong>$length</strong>    La longitud en bytes. Si se omite o se pasa <return>NULL</return>, extrae todos los bytes hasta
                     el final del string.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_strcut()</strong> devuelve la porción de <strong>$str</strong> especificada por los parámetros <strong>$start</strong> y <strong>$length</strong>.

<comment>See Also:</comment>
   * <strong>mb_substr()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_strimwidth
type: function
doc:
<comment>Description:</comment>
  Obtiene un string truncado con el ancho especificado
  
  Trunca el <info>string</info> <strong>$str</strong> al ancho especificado por <strong>$width</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>         El <info>string</info> a codificar.
  <info>int</info>     <strong>$start</strong>       El índice de la posición de inicio. El número de caracteres desde el comienzo
                       del string. (El índice del primer carácter es 0)
  <info>int</info>     <strong>$width</strong>       El ancho del recorte deseado.
  <info>string</info>  <strong>$trimmarker</strong>  Un string que se añade al final del string  cuando éste es truncado.
  <info>string</info>  <strong>$encoding</strong>    El parámetro <strong>$encoding</strong>
                       es la codificación de caracteres. Si es omitido, será usado el valor de la
                       codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info> truncado. Si se establece <strong>$trimmarker</strong>, <strong>$trimmarker</strong> reemplaza los últimos
          caracters que coincidan con <strong>$width</strong>.

<comment>See Also:</comment>
   * <strong>mb_strwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_stripos
type: function
doc:
<comment>Description:</comment>
  Busca la posición de la primera ocurrencia de un string dentro de otro, insensible a
  mayúsculas/minúsculas
  
  <strong>mb_stripos()</strong> devuelve la posición numérica de la primera ocurrencia de <strong>$needle</strong> en el string
  <strong>$haystack</strong>. A diferencia de <strong>mb_strpos()</strong>,  <strong>mb_stripos()</strong> es insensible a mayúsculas/minúsculas. Si no
  se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El string desde el que obtener la posición de la primera ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>    El string a buscar en <strong>$haystack</strong>
  <info>int</info>     <strong>$offset</strong>    La posición de <strong>$haystack</strong> donde empezar la búsquda
  <info>string</info>  <strong>$encoding</strong>  El nombre de la codificación de caracteres a usar. Si se omite, se usará la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  Devuelve la posición numérica de la pirmera ocurrencia de <strong>$needle</strong> en el string <strong>$haystack</strong>, o
       <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>stripos()</strong>
   * <strong>strpos()</strong>
   * <strong>mb_strpos()</strong>


id: mb_stristr
type: function
doc:
<comment>Description:</comment>
  Busca la primera ocurrencia de un string dentro de otro, insensible a mayúsculas/minúsculas
  
  <strong>mb_stristr()</strong> busca la primera ocurrencia de <strong>$needle</strong> en <strong>$haystack</strong> y devuelve la porción de
  <strong>$haystack</strong>. A diferencia de <strong>mb_strstr()</strong>,  <strong>mb_stristr()</strong> es insensible a mayúsculas/minúsculas. Si no
  se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       El string desde el que obtener la primera ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>         El string a buscar en <strong>$haystack</strong>
  <info>bool</info>    <strong>$before_needle</strong>  Determina qué porción de <strong>$haystack</strong> devuelve esta función. Si se establece
                          a <info>true</info>, devuelve todo el <strong>$haystack</strong> desde el comienzo de la primera
                          ocurrencia de <strong>$needle</strong> (excluyendo needle). Si se establece a <info>false</info>,
                          Devuelve todo el <strong>$haystack</strong> desde la primera ocurrencia de <strong>$needle</strong> hasta el
                          final (incluyendo needle).
  <info>string</info>  <strong>$encoding</strong>       El nombre de la codificación de caracteres a usar. Si se omite, se usará
                          la codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  Devuelve la porción de <strong>$haystack</strong>, o <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_strstr()</strong>


id: mb_strlen
type: function
doc:
<comment>Description:</comment>
  Obtiene la longitud de una cadena de caracteres
  
  Obtiene la longitud de un <info>string</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> del que se va a obtener su longitud.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el número de caracteres del <info>string</info> <strong>$str</strong>, teniendo éste una codificación de
         caracteres dada por <strong>$encoding</strong>. Un carácter multibyte cuenta como 1.
         
         Devuelve <info>false</info> si la codificación dada por <strong>$encoding</strong> no es válida.
         
         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>mb_internal_encoding()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>strlen()</strong>


id: mb_strpos
type: function
doc:
<comment>Description:</comment>
  Busca la posición de la primera ocurrencia de un string en otro string
  
  Busca la posición de la primera ocurrencia de un <info>string</info> en otro <info>string</info>.
  
  Realiza una operación <strong>strpos()</strong> segura multibyte basada en el número de caracteres. La posición del
  primer carácter es 0, la posición del segundo carácter es 1, etc.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El <info>string</info> a comprobar.
  <info>string</info>  <strong>$needle</strong>    El string a buscar en <strong>$haystack</strong>. A diferencia de <strong>strpos()</strong>, los valores
                     numéricos no se aplican como el valor ordinal de un carácter.
  <info>int</info>     <strong>$offset</strong>    El índice de búsqueda. Si no se especifica se usará 0.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  Devuelve la posición numéricia de la primera ocurrencia de <strong>$needle</strong> en el <info>string</info> <strong>$haystack</strong>. Si
       no se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strpos()</strong>


id: mb_strrchr
type: function
doc:
<comment>Description:</comment>
  Busca la última ocurrencia de un carácter de un string dentro de otro
  
  <strong>mb_strrchr()</strong> busca la última ocurrencia de <strong>$needle</strong> en <strong>$haystack</strong> y devuelve la porción de
  <strong>$haystack</strong>. Si no se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El string desde el que obtener la última ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>    El string a buscar en <strong>$haystack</strong>
  <info>bool</info>    <strong>$part</strong>      Determina qué porción de <strong>$haystack</strong> devuelve esta función. Si se establece a
                     <info>true</info>, devuelve todo el <strong>$haystack</strong> desde el comienzo de la última ocurrencia de
                     <strong>$needle</strong>. Si se establece a <info>false</info>, devuelve todo el <strong>$haystack</strong> desde la última
                     ocurrencia de <strong>$needle</strong> hasta el final.
  <info>string</info>  <strong>$encoding</strong>  El nombre de la codificación de caracteres a usar. Si se omite, se usará la
                     codificación de caracterse interna.

<comment>Return:</comment>
  <info>string</info>  Devuelve la porción de <strong>$haystack</strong>. o <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>mb_strstr()</strong>
   * <strong>mb_strrichr()</strong>


id: mb_strrichr
type: function
doc:
<comment>Description:</comment>
  Busca la última ocurrencia de un carácter de un string dentro de otro, insensible a
  mayúsculas/minúsculas
  
  <strong>mb_strrichr()</strong> busca la última ocurrencia de <strong>$needle</strong> en <strong>$haystack</strong> y devuelve la porción de
  <strong>$haystack</strong>. A diferencia de <strong>mb_strrchr()</strong>, <strong>mb_strrichr()</strong> es insensible a mayúsculas/minúsculas. Si
  no se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El string desde el que obtener la última ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>    El string a buscar en <strong>$haystack</strong>
  <info>bool</info>    <strong>$part</strong>      Determina qué porción de <strong>$haystack</strong> devuelve esta función. Si se establece a
                     <info>true</info>, devuelve todo el <strong>$haystack</strong> desde el comienzo de la última ocurrencia de
                     <strong>$needle</strong>. Si se establece a <info>false</info>, devuelve todo el <strong>$haystack</strong> desde la última
                     ocurrencia de <strong>$needle</strong> hasta el final.
  <info>string</info>  <strong>$encoding</strong>  El nombre de la codificación de caracteres a usar. Si se omite, se usará la
                     codificación de caracterse interna.

<comment>Return:</comment>
  <info>string</info>  Devuelve la porción de <strong>$haystack</strong>. o <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>mb_stristr()</strong>
   * <strong>mb_strrchr()</strong>


id: mb_strripos
type: function
doc:
<comment>Description:</comment>
  Busca la posicion de la última ocurrencia de un string dentro de otro string, insensible a
  mayúsculas/minúsculas
  
  Realiza una operación <strong>strpos()</strong> segura multibyte basada en el número de caracteres. La posición de
  <strong>$needle</strong> se cuenta desde el comienzo de <strong>$haystack</strong>. La posición del primer carácter es 0. La
  posición del segundo carácter es 1.  A diferencia de <strong>mb_strrpos()</strong>, <strong>mb_strripos()</strong> es insensible a
  mayúsculas/minúsculas.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El string a comprobar, para la última ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>    El string a buscar en <strong>$haystack</strong>.
  <info>int</info>     <strong>$offset</strong>    La posición de <strong>$haystack</strong> donde iniciar la búsqueda
  <info>string</info>  <strong>$encoding</strong>  El nombre de la codificación de caracteres a usar. Si se omite, se usará la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  evuelve la posición numérica de la última ocurrencia de <strong>$needle</strong> en el string <strong>$haystack</strong>, o
       <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>strripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>mb_strrpos()</strong>


id: mb_strrpos
type: function
doc:
<comment>Description:</comment>
  Busca la posicion de la última ocurrencia de un string en otro string
  
  Realiza una operación <strong>strpos()</strong> segura multibyte basada en el número de caracteres. La posición de
  <strong>$needle</strong> se cuenta desde el comienzo de <strong>$haystack</strong>. La posición del primer carácter es 0. La
  posición del segundo carácter es 1.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El <info>string</info> a comprobar, para la última ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>    El <info>string</info> a buscar en <strong>$haystack</strong>.
  <info>int</info>     <strong>$offset</strong>    Se podría especificar para comenzar la búsqueda de un número arbitrario de
                     caracteres dentro del <info>string</info>. Los valores negativos detendrán la búsqueda en un
                     punto arbitrario anterior al final del <info>string</info>.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  Devuelve la posición numérica de la última ocurrencia de <strong>$needle</strong> en el <info>string</info> <strong>$haystack</strong>. Si
       no se encuentra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strrpos()</strong>


id: mb_strstr
type: function
doc:
<comment>Description:</comment>
  Busca la primera ocurrencia de un string dentro de otro
  
  <strong>mb_strstr()</strong> busca la primera ocurrencia de <strong>$needle</strong> en <strong>$haystack</strong> y devuelve la porción de
  <strong>$haystack</strong>. Si no se encunetra <strong>$needle</strong>, devuelve <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       El string desde el que obtener la primera ocurrencia de <strong>$needle</strong>
  <info>string</info>  <strong>$needle</strong>         El string a buscar en <strong>$haystack</strong>
  <info>bool</info>    <strong>$before_needle</strong>  Determina qué porción de <strong>$haystack</strong> devuelve esta función. Si se establece
                          a <info>true</info>, devuelve todo el <strong>$haystack</strong> desde el comienzo de la primera
                          ocurrencia de <strong>$needle</strong> (incluyendo needle). Si se establece a <info>false</info>,
                          Devuelve todo el <strong>$haystack</strong> desde la primera ocurrencia de <strong>$needle</strong> hasta el
                          final (excluyendo needle).
  <info>string</info>  <strong>$encoding</strong>       El nombre de la codificación de caracteres a usar. Si se omite, se usará
                          la codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  Devuelve la porción de <strong>$haystack</strong>, o <info>false</info> si no se encuentra <strong>$needle</strong>.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_stristr()</strong>


id: mb_strtolower
type: function
doc:
<comment>Description:</comment>
  Convierte una cadena de caracteres a minúsculas
  
  Devuelve <strong>$str</strong> con todos los caracteres alfabéticos convertidos a minúscula.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a convertir.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  <strong>$str</strong> con todos los caracteres alfabéticos convertidos a minúscula.

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


id: mb_strtoupper
type: function
doc:
<comment>Description:</comment>
  Convierte un string en mayúsculas
  
  Devuelve <strong>$str</strong> con todos los caracteres alfabéticos convertidos a mayúsculas.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a convertir en mayúsculas.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  <strong>$str</strong> con todos los caracteres alfabéticoas convertidos a mayúsculas.

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


id: mb_strwidth
type: function
doc:
<comment>Description:</comment>
  Devuelve el ancho de un string
  
  Devuelve el ancho del <info>string</info> <strong>$str</strong>.
  
  Los caracteres multibyte normalmente son el doble de anchos que los caracteres de un único byte.
  
  Ancho de  caracteresCaracteresAnchoU+0000 - U+00190U+0020 - U+1FFF1U+2000 - U+FF602U+FF61 -
  U+FF9F1U+FFA0 -      2

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> a decodificar.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  El ancho del <info>string</info> <strong>$str</strong>.

<comment>See Also:</comment>
   * <strong>mb_strimwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substitute_character
type: function
doc:
<comment>Description:</comment>
  Establece/obtiene un carácter de sustitución
  
  Especifica un carácter de sustitución cuando la codificación de caracteres de entrada es inválida
  o el código del carácter no existe en la codificación de caracteres de salida. Los caracteres
  inválidos pueden ser sustituidos por valores <info>null</info> (sin salida), <info>string</info> o <info>integer</info> (valor del código
  del carácter Unicode).
  
  Esta configuración afecta a <strong>mb_convert_encoding()</strong>, <strong>mb_convert_variables()</strong>, <strong>mb_output_handler()</strong>, y
  <strong>mb_send_mail()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$substrchar</strong>  Especifica el valor Unicode como un <info>integer</info>,  o como uno de los siguientes
                      <info>string</info>s: <return>"none"</return>: sin salida <return>"long"</return> : Producir el valor del código del carácter
                      (Ejemplo: U+3000, JIS+7E7E) <return>"entity"</return> : Producir la entidad del carácter
                      (Ejemplo: Ȁ)
                      
                      <return>"none"</return>: sin salida
                      
                      <return>"long"</return> : Producir el valor del código del carácter (Ejemplo: U+3000, JIS+7E7E)
                      
                      <return>"entity"</return> : Producir la entidad del carácter (Ejemplo: Ȁ)

<comment>Return:</comment>
  <info>mixed</info>  Si se establece <strong>$substchar</strong>, devuelve <info>true</info> en caso de éxito, o en caso contrairo devuelve
         <info>false</info>.  Si <strong>$substchar</strong> no se establece, devuelve el ajuste actual.


id: mb_substr
type: function
doc:
<comment>Description:</comment>
  Obtiene parte de una cadena de caracteres
  
  Realiza una operación  <strong>substr()</strong> multibyte de forma segura basada en el número de caracteres. La
  posición se cuenta desde el principio de <strong>$str</strong>. La posición del primer carácter es 0. La posición
  del segundo es 1, etc.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El <info>string</info> de donde extraer la parte deseada.
  <info>int</info>     <strong>$start</strong>     Si <strong>$start</strong> no es negativo, el string devuelto comenzará en la posición
                     <strong>$start</strong>-ésima de <strong>$str</strong>, empezando desde cero. Por ejemplo, en el string '<return>abcdef</return>',
                     el carácter en la posición <return>0</return> es '<return>a</return>', el carácter en la posición <return>2</return> es '<return>c</return>', etc.
                     
                     Si <strong>$start</strong> es negativo, el string devuelto comenzará en el <strong>$start</strong>-ésimo carácter
                     desde el final de <strong>$str</strong>.
  <info>int</info>     <strong>$length</strong>    El número máximo de caracteres a usar de <strong>$str</strong>. Si se omite o se pasa <return>NULL</return>,
                     extrae todos los caracteres hasta el final del string.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_substr()</strong> devuelve una parte de <strong>$str</strong> especificada por los parametros <strong>$start</strong> y <strong>$length</strong>.

<comment>See Also:</comment>
   * <strong>mb_strcut()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substr_count
type: function
doc:
<comment>Description:</comment>
  Cuenta el número de ocurrencias de un substring
  
  Cuenta el número de veces que el substring <strong>$needle</strong> aparece en el <info>string</info> <strong>$haystack</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  El <info>string</info> a comprobar.
  <info>string</info>  <strong>$needle</strong>    El <info>string</info> a buscar.
  <info>string</info>  <strong>$encoding</strong>  El parámetro <strong>$encoding</strong>
                     es la codificación de caracteres. Si es omitido, será usado el valor de la
                     codificación de caracteres interna.

<comment>Return:</comment>
  <info>int</info>  El número de veces que el substring <strong>$needle</strong> aparece en el <info>string</info> <strong>$haystack</strong>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_substr()</strong>
   * <strong>substr_count()</strong>


id: mcrypt_create_iv
type: function
doc:
<comment>Description:</comment>
  Creates an initialization vector (IV) from a random source
  
  Creates an initialization vector (IV) from a random source.
  
  The IV is only meant to give an alternative seed to the encryption routines. This IV does not need
  to be secret at all, though it can be desirable. You even can send it along with your ciphertext
  without losing security.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>    The size of the IV.
  <info>int</info>  <strong>$source</strong>  The source of the IV. The source can be <info>MCRYPT_RAND</info> (system random number
                generator), <info>MCRYPT_DEV_RANDOM</info> (read data from /dev/random) and <info>MCRYPT_DEV_URANDOM</info>
                (read data from /dev/urandom). Prior to 5.3.0, <info>MCRYPT_RAND</info> was the only one
                supported on Windows.
                
                Note that the default value of this parameter was <info>MCRYPT_DEV_RANDOM</info> prior to PHP
                5.6.0.
                
                Note that <info>MCRYPT_DEV_RANDOM</info> may block until more entropy is available.

<comment>Return:</comment>
  <info>string</info>  Returns the initialization vector, or <info>false</info> on error.

<comment>See Also:</comment>
   * http://www.ciphersbyritter.com/GLOSSARY.HTM#IV
   * http://www.quadibloc.com/crypto/co0409.htm
   * Chapter 9.3 of Applied Cryptography by Schneier (ISBN 0-471-11709-9)
   * <strong>random_bytes()</strong>


id: mcrypt_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts crypttext with given parameters
  
  Decrypts the <strong>$data</strong> and returns the unencrypted data.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                   string.
  <info>string</info>  <strong>$key</strong>     The key with which the data was encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be decrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
  <info>string</info>  <strong>$mode</strong>    Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes strings:
                   "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".
  <info>string</info>  <strong>$iv</strong>      Utilizado para la inicialización en los modos CBC, CFB, OFB, y en algunos
                   algoritmos en el modo STREAM. Si el tamañlo del IV proporcionado no está
                   soportado por el modo de encadenamiento o no se proporcionó ninún IV, y el modo
                   de encadenamiento requiere uno, la función emitirá una advertencia y devolverá
                   <info>false</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the decrypted data as a string  o <info>false</info> en caso de error.

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


id: mcrypt_enc_get_algorithms_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened algorithm
  
  This function returns the name of the algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>string</info>  Returns the name of the opened algorithm as a string.


id: mcrypt_enc_get_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the opened algorithm
  
  Gets the blocksize of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the specified algorithm in bytes.


id: mcrypt_enc_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV of the opened algorithm
  
  This function returns the size of the IV of the algorithm specified by the encryption descriptor
  in bytes. An IV is used in cbc, cfb and ofb modes, and in some algorithms in stream mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the IV, or 0 if the IV is ignored by the algorithm.


id: mcrypt_enc_get_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported key size of the algorithm in bytes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum supported key size of the algorithm in bytes.


id: mcrypt_enc_get_modes_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened mode
  
  This function returns the name of the mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

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


id: mcrypt_enc_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Gets the supported key sizes of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the algorithm specified by the encryption
         descriptor. If it returns an empty array then all key sizes between 1 and
         <strong>mcrypt_enc_get_key_size()</strong> are supported by the algorithm.


id: mcrypt_enc_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  Checks whether the algorithm of the opened mode is a block algorithm
  
  Tells whether the algorithm of the opened mode is a block algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the algorithm is a block algorithm or <info>false</info> if it is a stream one.


id: mcrypt_enc_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the encryption of the opened mode works on blocks
  
  Tells whether the algorithm of the opened mode works on blocks (e.g. <info>false</info> for stream, and <info>true</info>
  for cbc, cfb, ofb)..

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns <info>false</info>.


id: mcrypt_enc_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the opened mode outputs blocks
  
  Tells whether the opened mode outputs blocks (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and
  stream).

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode outputs blocks of bytes, or <info>false</info> if it outputs just bytes.


id: mcrypt_enc_self_test
type: function
doc:
<comment>Description:</comment>
  Runs a self test on the opened module
  
  This function runs the self test on the algorithm specified by the descriptor <strong>$td</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns <return>0</return> on success and a negative <info>int</info> on failure.


id: mcrypt_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts plaintext with given parameters
  
  Encrypts the data and returns it.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                   string.
  <info>string</info>  <strong>$key</strong>     The key with which the data will be encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be encrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
                   
                   The returned crypttext can be larger than the size of the data that was given by
                   <strong>$data</strong>.
  <info>string</info>  <strong>$mode</strong>    Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes strings:
                   "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".
  <info>string</info>  <strong>$iv</strong>      Utilizado para la inicialización en los modos CBC, CFB, OFB, y en algunos
                   algoritmos en el modo STREAM. Si el tamañlo del IV proporcionado no está
                   soportado por el modo de encadenamiento o no se proporcionó ninún IV, y el modo
                   de encadenamiento requiere uno, la función emitirá una advertencia y devolverá
                   <info>false</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the encrypted data as a string  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mcrypt_decrypt()</strong>
   * <strong>mcrypt_module_open()</strong>


id: mcrypt_generic
type: function
doc:
<comment>Description:</comment>
  This function encrypts data
  
  This function encrypts data. The data is padded with "<return>\0</return>" to make sure the length of the data is n
  * blocksize. This function returns the encrypted data. Note that the length of the returned string
  can in fact be longer than the input, due to the padding of the data.
  
  If you want to store the encrypted data in a database make sure to store the entire string as
  returned by mcrypt_generic, or the string will not entirely decrypt properly.  If your original
  string is 10 characters long and the block size is 8 (use <strong>mcrypt_enc_get_block_size()</strong> to determine
  the blocksize), you would need at least 16 characters in your database field. Note the string
  returned by <strong>mdecrypt_generic()</strong> will be 16 characters as well...use rtrim($str, "\0") to remove the
  padding.
  
  If you are for example storing the data in a MySQL database remember that varchar fields
  automatically have trailing spaces removed during insertion. As encrypted data can end in a space
  (ASCII 32), the data will be damaged by this removal.  Store data in a tinyblob/tinytext (or
  larger) field instead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    The encryption descriptor.
                   
                   The encryption handle should always be initialized with <strong>mcrypt_generic_init()</strong>
                   with a key and an IV before calling this function. Where the encryption is done,
                   you should free the encryption buffers by calling <strong>mcrypt_generic_deinit()</strong>. See
                   <strong>mcrypt_module_open()</strong> for an example.
  <info>string</info>    <strong>$data</strong>  The data to encrypt.

<comment>Return:</comment>
  <info>string</info>  Returns the encrypted data.

<comment>See Also:</comment>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_generic_deinit
type: function
doc:
<comment>Description:</comment>
  This function deinitializes an encryption module
  
  This function terminates encryption specified by the encryption descriptor (<strong>$td</strong>). It clears all
  buffers, but does not close the module.  You need to call <strong>mcrypt_module_close()</strong> yourself. (But PHP
  does this for you at the end of the script.)

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

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


id: mcrypt_generic_init
type: function
doc:
<comment>Description:</comment>
  This function initializes all buffers needed for encryption
  
  You need to call this function before every call to <strong>mcrypt_generic()</strong> or <strong>mdecrypt_generic()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>   The encryption descriptor.
  <info>string</info>    <strong>$key</strong>  The maximum length of the key should be the one obtained by calling
                  <strong>mcrypt_enc_get_key_size()</strong> and every value smaller than this is legal.
  <info>string</info>    <strong>$iv</strong>   The IV should normally have the size of the algorithms block size, but you must
                  obtain the size by calling <strong>mcrypt_enc_get_iv_size()</strong>. IV is ignored in ECB. IV MUST
                  exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and unique
                  (but not secret). The same IV must be used for encryption/decryption. If you do
                  not want to use it you should set it to zeros, but this is not recommended.

<comment>Return:</comment>
  <info>int</info>  The function returns a negative value on error: -3 when the key length was incorrect, -4 when
       there was a memory allocation problem and any other return value is an unknown error. If an
       error occurs a warning will be displayed accordingly. <info>false</info> is returned if incorrect
       parameters were passed.

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


id: mcrypt_get_block_size
type: function
doc:
<comment>Description:</comment>
  Gets the block size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_block_size()</strong> is used to get the size of a block of the specified <strong>$cipher</strong> (in
  combination with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_block_size()</strong> function as this uses the resource
  returned by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                   string.
  <info>string</info>  <strong>$mode</strong>    Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes strings:
                   "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the algorithm block size in bytes  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>mcrypt_get_key_size()</strong>
   * <strong>mcrypt_enc_get_block_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_get_cipher_name
type: function
doc:
<comment>Description:</comment>
  Gets the name of the specified cipher
  
  <strong>mcrypt_get_cipher_name()</strong> is used to get the name of the specified cipher.
  
  <strong>mcrypt_get_cipher_name()</strong> takes the cipher number as an argument (libmcrypt 2.2.x) or takes the
  cipher name as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher or
  <info>false</info>, if the cipher does not exist.

<comment>Param:</comment>
  <info>int</info>  <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                string.

<comment>Return:</comment>
  <info>string</info>  This function returns the name of the cipher or <info>false</info> if the cipher does not exist.


id: mcrypt_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV belonging to a specific cipher/mode combination
  
  Gets the size of the IV belonging to a specific  <strong>$cipher</strong>/<strong>$mode</strong> combination.
  
  It is more useful to use the <strong>mcrypt_enc_get_iv_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                   string.
  <info>string</info>  <strong>$mode</strong>    Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes strings:
                   "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".
                   
                   The IV is ignored in ECB mode as this mode does not require it. You will need to
                   have the same IV (think: starting point) both at encryption and decryption
                   stages, otherwise your encryption will fail.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the Initialization Vector (IV) in bytes. On error the function returns
       <info>false</info>. If the IV is ignored in the specified cipher/mode combination zero is returned.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_iv_size()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: mcrypt_get_key_size
type: function
doc:
<comment>Description:</comment>
  Gets the key size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_key_size()</strong> is used to get the size of a key of the specified <strong>$cipher</strong> (in combination
  with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_key_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                   string.
  <info>string</info>  <strong>$mode</strong>    Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes strings:
                   "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the maximum supported key size of the algorithm in bytes o <info>false</info> en caso de
             error.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_key_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_list_algorithms
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported ciphers
  
  Gets the list of all supported algorithms in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all algorithms are located. If not specified, the
                    value of the <return>mcrypt.algorithms_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported algorithms.


id: mcrypt_list_modes
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported modes
  
  Gets the list of all supported modes in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all modes are located. If not specified, the value
                    of the <return>mcrypt.modes_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported modes.


id: mcrypt_module_close
type: function
doc:
<comment>Description:</comment>
  Closes the mcrypt module
  
  Closes the specified encryption handle.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

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


id: mcrypt_module_get_algo_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the specified algorithm
  
  Gets the blocksize of the specified algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the algorithm specified in bytes.


id: mcrypt_module_get_algo_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported keysize of the opened mode.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  This function returns the maximum supported key size of the algorithm specified in bytes.


id: mcrypt_module_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Returns an array with the key sizes supported by the specified algorithm. If it returns an empty
  array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are supported by the
  algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to be used.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the specified algorithm. If it returns an
         empty array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are
         supported by the algorithm.

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


id: mcrypt_module_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  This function checks whether the specified algorithm is a block algorithm
  
  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it is a
  stream one.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to check.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it
        is a stream one.


id: mcrypt_module_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified module is a block algorithm or not
  
  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns
  <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     The mode to check.
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it
        returns <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).


id: mcrypt_module_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified mode outputs blocks or not
  
  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just bytes.
  (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las siguientes
                    strings: "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just
        bytes. (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).


id: mcrypt_module_open
type: function
doc:
<comment>Description:</comment>
  Opens the module of the algorithm and the mode to be used
  
  This function opens the module of the algorithm and the mode to be used. The name of the algorithm
  is specified in algorithm, e.g. <return>"twofish"</return> or is one of the <info>MCRYPT_ciphername</info> constants.  The
  module is closed by calling <strong>mcrypt_module_close()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>            Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del
                                algoritmo como string.
  <info>string</info>  <strong>$algorithm_directory</strong>  The <strong>$algorithm_directory</strong> parameter is used to locate the encryption
                                module. When you supply a directory name, it is used.  When you set
                                it to an empty string (<return>""</return>), the value set by the
                                <return>mcrypt.algorithms_dir</return> php.ini directive is used. When it is not set,
                                the default directory that is used is the one that was compiled into
                                libmcrypt (usually /usr/local/lib/libmcrypt).
  <info>string</info>  <strong>$mode</strong>                 Una de las constantes <info>MCRYPT_MODE_nombredelmodo</info>, o una de las
                                siguientes strings: "ecb", "cbc", "cfb", "ofb", "nofb" o "stream".
  <info>string</info>  <strong>$mode_directory</strong>       The <strong>$mode_directory</strong> parameter is used to locate the encryption
                                module. When you supply a directory name, it is used.  When you set
                                it to an empty string (<return>""</return>), the value set by the <return>mcrypt.modes_dir</return>
                                php.ini directive is used. When it is not set, the default directory
                                that is used is the one that was compiled-in into libmcrypt (usually
                                /usr/local/lib/libmcrypt).

<comment>Return:</comment>
  <info>resource</info>  Normally it returns an encryption descriptor, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mcrypt_module_close()</strong>
   * <strong>mcrypt_generic()</strong>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_module_self_test
type: function
doc:
<comment>Description:</comment>
  This function runs a self test on the specified module
  
  This function runs the self test on the algorithm specified.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  Una de las constantes <info>MCRYPT_nombredelcifrado</info>, o el nombre del algoritmo como
                      string.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>bool</info>  The function returns <info>true</info> if the self test succeeds, or <info>false</info> when it fails.


id: md5
type: function
doc:
<comment>Description:</comment>
  Calcula el 'hash' md5 de un string
  
  Calcula el hash MD5 de <strong>$str</strong> utilizando el Algoritmo MD5 Message-Digest de RSA Data Security, Inc.
  y devuelve ese hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>         El string.
  <info>bool</info>    <strong>$raw_output</strong>  Si se establece el <strong>$raw_output</strong> opcional en <info>true</info>, el resumen md5 será devuelto
                       en formato binario sin tratar con una longitud de 16.

<comment>Return:</comment>
  <info>string</info>  Devuelve el hash como un número hexadecimal de 32 caracteres.

<comment>See Also:</comment>
   * <strong>md5_file()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>
   * <strong>sha1()</strong>
   * <strong>hash()</strong>
   * <strong>crypt()</strong>
   * <strong>password_hash()</strong>


id: md5_file
type: function
doc:
<comment>Description:</comment>
  Calcula el resumen criptográfico md5 de un archivo dado
  
  Calcula el resumen criptográfico MD5 del archivo especificado por el parámetro <strong>$filename</strong> usando el
  Algoritmo de resumen de mensajes MD5 de RSA Data Security, Inc., y devuelve ese resumen. El
  resumen criptográfico es un número hexadecimal de 32 caracteres.

<comment>Param:</comment>
  <info></info>      <strong>$nombre_archivo</strong>  El nombre de archivo
  <info>bool</info>  <strong>$raw_output</strong>      Cuando es <info>true</info>, devuelve el resumen en un formato binario primitivo con una
                         longitud de 16.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito, <info>false</info> de lo contrario.

<comment>See Also:</comment>
   * <strong>md5()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>


id: mdecrypt_generic
type: function
doc:
<comment>Description:</comment>
  Decrypts data
  
  This function decrypts data. Note that the length of the returned string can in fact be longer
  than the unencrypted string, due to the padding of the data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    An encryption descriptor returned by <strong>mcrypt_module_open()</strong>
  <info>string</info>    <strong>$data</strong>  Encrypted data.

<comment>Return:</comment>
  <info>string</info>  Returns decrypted string.

<comment>See Also:</comment>
   * <strong>mcrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: memcache_debug
type: function
doc:
<comment>Description:</comment>
  Activa/desactiva debug output
  
  <strong>memcache_debug()</strong> activa el debug output si el parámetro <strong>$on_off</strong> es igual a <info>true</info> y lo desactiva si
  es igual a <info>false</info>.  Solamente se puede acceder a <strong>memcache_debug()</strong> si PHP fue compilado con la
  opción --enable-debug y en este caso siempre retorna <info>true</info>. De lo contrario, esta función no tiene
  ningún efecto y siempre devuelve <info>false</info>.
  
  Solamente se puede acceder a <strong>memcache_debug()</strong> si PHP fue compilado con la opción --enable-debug y
  en este caso siempre retorna <info>true</info>. De lo contrario, esta función no tiene ningún efecto y siempre
  devuelve <info>false</info>.

<comment>Param:</comment>
  <info>bool</info>  <strong>$on_off</strong>  Activa debug output si es igual a <info>true</info>. Desactiva debug output si es igual a <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si PHP fue compilado con la opción --enable-debug, de lo contrario devuelve
        <info>false</info>.


id: memory_get_peak_usage
type: function
doc:
<comment>Description:</comment>
  Devuelve el máximo de memoria asignada por PHP
  
  Devuelve el máximo de memoria, en bytes, que se ha asignado a su  script PHP.

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  Si se deja en <info>true</info> puede obtener el tamaño real de memoria asignada por el
                     sistema.  Si no se establece o es <info>false</info>, la memoria utilizada por  <return>emalloc()</return> es
                     reportada.

<comment>Return:</comment>
  <info>int</info>  Devuelve el máximo de memoria en bytes.

<comment>See Also:</comment>
   * <strong>memory_get_usage()</strong>
   * memory_limit


id: memory_get_usage
type: function
doc:
<comment>Description:</comment>
  Devuelve la cantidad de memoria asignada a PHP
  
  Devuelve la cantidad de memoria, en bytes, que actualmente se asigna  a su script PHP.

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  Establecer esto a <info>true</info> para obtener el tamaño real de memoria  asignada por el
                     sistema. Incluyendo las páginas no usadas. Si no se establece o es <info>false</info> solo
                     se informa de la memoria utilizada.

<comment>Return:</comment>
  <info>int</info>  Devuelve la cantidad de memoria en bytes.

<comment>See Also:</comment>
   * <strong>memory_get_peak_usage()</strong>
   * memory_limit


id: memory_reset_peak_usage
type: function
doc:
<comment>Description:</comment>
  Reset the peak memory usage
  
  Resets the peak memory usage returned by the <strong>memory_get_peak_usage()</strong> function.

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

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


id: metaphone
type: function
doc:
<comment>Description:</comment>
  Calcula la clave metaphone de un string
  
  Calcula la clave metaphone de <strong>$str</strong>.
  
  De manera similar a <strong>soundex()</strong>, metaphone crea la misma clave para palabras que suenan parecido. Es
  más precisa que <strong>soundex()</strong> ya que conoce las reglas básicas de la pronunciación del inglés. Las
  claves generadas por metaphone son de longitud variable.
  
  Metaphone fue desarrollado por Lawrence Philips \<lphilips at verity dot com&gt;. Se describe en ["Practical Algorithms for Programmers", Binstock & Rex, Addison Wesley, 1995].

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>       El string de entrada.
  <info>int</info>     <strong>$phonemes</strong>  Este parámetro restringe la clave devuelta por metaphone a lo indicado en
                     <strong>$phonemes</strong> en caracteres de longitud. El valor por defecto es <return>0</return> lo que significa
                     que no hay restricción

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


id: method_exists
type: function
doc:
<comment>Description:</comment>
  Comprueba si existe un método de una clase
  
  Comprueba si existe el método de la clase en el objeto dado por <strong>$object</strong>.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object</strong>       Una instancia o un nombre de clase
  <info>string</info>  <strong>$method_name</strong>  El nombre del método

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el método dado por <strong>$method_name</strong> ha sido definido para el objeto dado por
        <strong>$object</strong>, <info>false</info>  si no.

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>is_callable()</strong>
   * <strong>class_exists()</strong>


id: mhash
type: function
doc:
<comment>Description:</comment>
  Computes hash
  
  <strong>mhash()</strong> applies a hash function specified by <strong>$algo</strong> to the <strong>$data</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$algo</strong>  The hash ID. One of the <info>MHASH_hashname</info> constants.
  <info>string</info>       <strong>$data</strong>  The user input, as a string.
  <info>string|null</info>  <strong>$key</strong>   If specified, the function will return the resulting HMAC instead. HMAC is
                      keyed hashing for message authentication, or simply a message digest that
                      depends on the specified key. Not all algorithms  supported in mhash can be
                      used in HMAC mode.

<comment>Return:</comment>
  <info>string|false</info>  Returns the resulting hash (also called digest) or HMAC as a string, or <info>false</info> on
                error.


id: mhash_count
type: function
doc:
<comment>Description:</comment>
  Gets the highest available hash ID
  
  Gets the highest available hash ID.

<comment>Return:</comment>
  <info>int</info>  Returns the highest available hash ID. Hashes are numbered from 0 to this hash ID.


id: mhash_get_block_size
type: function
doc:
<comment>Description:</comment>
  Gets the block size of the specified hash
  
  Gets the size of a block of the specified <strong>$algo</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  The hash ID. One of the <info>MHASH_hashname</info> constants.

<comment>Return:</comment>
  <info>int|false</info>  Returns the size in bytes or <info>false</info>, if the <strong>$algo</strong> does not exist.


id: mhash_get_hash_name
type: function
doc:
<comment>Description:</comment>
  Gets the name of the specified hash
  
  Gets the name of the specified <strong>$algo</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  The hash ID. One of the <info>MHASH_hashname</info> constants.

<comment>Return:</comment>
  <info>string|false</info>  Returns the name of the hash or <info>false</info>, if the hash does not exist.


id: mhash_keygen_s2k
type: function
doc:
<comment>Description:</comment>
  Generates a key
  
  Generates a key according to the given <strong>$algo</strong>, using an user provided <strong>$password</strong>.
  
  This is the Salted S2K algorithm as specified in the OpenPGP document (RFC 2440).
  
  Keep in mind that user supplied passwords are not really suitable to be used as keys in
  cryptographic algorithms, since users normally choose keys they can write on keyboard. These
  passwords use only 6 to 7 bits per character (or less). It is highly recommended to use some kind
  of transformation (like this function) to the user supplied key.

<comment>Param:</comment>
  <info>int</info>     <strong>$algo</strong>      The hash ID used to create the key. One of the <info>MHASH_hashname</info> constants.
  <info>string</info>  <strong>$password</strong>  An user supplied password.
  <info>string</info>  <strong>$salt</strong>      Must be different and random enough for every key you generate in order to
                     create different keys. Because <strong>$salt</strong> must be known when you check the keys, it
                     is a good idea to append the key to it. Salt has a fixed length of 8 bytes and
                     will be padded with zeros if you supply less bytes.
  <info>int</info>     <strong>$length</strong>    The key length, in bytes.

<comment>Return:</comment>
  <info>string|false</info>  Returns the generated key as a string, or <info>false</info> on error.


id: microtime
type: function
doc:
<comment>Description:</comment>
  Devuelve la fecha Unix actual con microsegundos
  
  <strong>microtime()</strong> devuelve la fecha Unix actual con microsegundos. Esta función sólo está disponible en
  sistemas operativos que soportan la llamada al sistema de gettimeofday().

<comment>Param:</comment>
  <info>bool</info>  <strong>$get_as_float</strong>  Si se usa y se establece a <info>true</info>, <strong>microtime()</strong> devolverá un <info>float</info> en vez de un
                       <info>string</info>, como está descrito en la sección de valores de retorno de abajo.

<comment>Return:</comment>
  <info>mixed</info>  Por omisión, <strong>microtime()</strong> devuelve un <info>string</info> en la forma "mseg seg", donde <return>seg</return> es el número
         de segundos desde la época Unix (0:00:00 January 1, 1970 GMT), y <return>msec</return> es el número de
         microsegundos que han transcurrido desde <return>sec</return>, expresado en segundos.
         
         Si <strong>$get_as_float</strong> está establecido a <info>true</info>, <strong>microtime()</strong> devuelve un <info>float</info>, que representa el
         momento actual en segundos desde la época Unix con precisión al microsegundo más cercano.

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


id: mime_content_type
type: function
doc:
<comment>Description:</comment>
  Detecta el MIME Content-type para un fichero
  
  Devuelve el MIME content type para un fichero determinado usando información desde el fichero
  magic.mime.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta para comprobar fichero.

<comment>Return:</comment>
  <info>string</info>  Devuelve el contenido en formato MIME como, <return>text/plain</return> o <return>application/octet-stream</return>, o <info>false</info>
          en caso de error.

<comment>See Also:</comment>
   * <strong>finfo_file()</strong>
   * <strong>finfo_buffer()</strong>


id: min
type: function
doc:
<comment>Description:</comment>
  Encontrar el valor más bajo
  
  Si el primer y único parámetro es un array, <strong>min()</strong> devuelve el valor más bajo de ese array. Si se
  proporcionan al menos dos parámetros, <strong>min()</strong> devuelve el menor de estos valores.
  
  Valores de diferentes tipos serán comparados utilizando las  reglas de comparación estándar. Por
  ejemplo, un <info>string</info> no numérico será comparado con un <info>integer</info> como si fuera <return>0</return>, aunque varios
  valores de tipo <info>string</info> serán comparados alfanuméricamente. El valor real devuelto será del tipo
  original sin ninguna conversión aplicada.

<comment>Param:</comment>
  <info></info>       <strong>$valores</strong>  Un array que contiene los valores.
  <info>mixed</info>  <strong>$value1</strong>   Cualquier valor comparable.
  <info>mixed</info>  <strong>$value2</strong>   Cualquier valor comparable.
  <info>mixed</info>  <strong>$...</strong>      Cualquier valor comparable.

<comment>Return:</comment>
  <info>mixed</info>  <strong>min()</strong> devuelve el valor del parámetro considerado "el menor" según la comparación estándar.
         Si varios valores de diferentes tipos se evalúan como iguales (p.ej. <return>0</return> y <return>'abc'</return>), será
         devuelto el primero proporcionado a la función.
         
         Si se pasa un array vacío, se devolverá <info>false</info> y se emitirá un error <info>E_WARNING</info>.

<comment>See Also:</comment>
   * <strong>max()</strong>
   * <strong>count()</strong>


id: mkdir
type: function
doc:
<comment>Description:</comment>
  Crea un directorio
  
  Intenta crear el directorio especificado por pathname.

<comment>Param:</comment>
  <info>string</info>    <strong>$pathname</strong>   La ruta del directorio.
  <info>int</info>       <strong>$mode</strong>       El modo predeterminado es 0777, lo que significa el acceso más amplio
                        posible. Para más información sobre los modos, lea los detalles en la página
                        de <strong>chmod()</strong>.
                        
                        <strong>$mode</strong> es ignorado en Windows.
                        
                        Observe que probablemente se quiera especificar el modo como un número
                        octal, lo que significa que debería de haber un cero inicial. El modo es
                        modificado también por la actual máscara de usuario, la cual se puede
                        cambiar usando <strong>umask()</strong>.
  <info>bool</info>      <strong>$recursive</strong>  Permite la creación de directorios anidados especificado en el parámetro
                        <strong>$pathname</strong>.
  <info>resource</info>  <strong>$context</strong>    Soporte para context fue
                        añadido en PHP 5.0.0. Para una descripción de <return>contexts</return>, refiérase a
                        .

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


id: mktime
type: function
doc:
<comment>Description:</comment>
  Obtener la marca de tiempo Unix de una fecha
  
  Devuelve la marca de tiempo Unix correspondiente a los argumentos dados. Esta marca de tiempo es
  un entero que contiene el número de segundos entre la Época Unix (1 de Enero del 1970 00:00:00
  GMT) y el instante especificado.
  
  Los argumentos pueden omitirse de derecha a izquierda; cualquier argumento que se omita será
  establecido al valor actual según la fecha y hora locales.

<comment>Param:</comment>
  <info>int</info>  <strong>$hour</strong>    El número de la hora relativa al inicio del día determinado por <strong>$month</strong>, <strong>$day</strong> y
                <strong>$year</strong>. Los valores negativos referencian la hora antes de la media noche del día en
                cuestión. Los valores mayores que 23 referencian la hora apropiada en el/los día/s
                siguiente/s.
  <info>int</info>  <strong>$minute</strong>  El número de los minutos relativos al inicio de <strong>$hour</strong>. Los valores negativos
                referencian el minuto en la hora previa. Los valores mayores que 59 referencian el
                minuto apropiado en la/s hora/s siguiente/s.
  <info>int</info>  <strong>$second</strong>  El número de segundos relativos al inicio de <strong>$minute</strong>. Los valores negativos
                referencian el segundo en el minuto previo. Los valores mayores que 59 referencian
                el segundo apropiado en el/los minuto/s siguiente/s.
  <info>int</info>  <strong>$month</strong>   El número del mes relativo al final del año previo. Los valores de 1 a 12
                referencian los meses del calendario normal del año en cuestión. Los valores menores
                que 1 (incluyendo valores negativos) referencian los meses del año previo en orden
                inverso, por lo que 0 es Diciembre, -1 es Noviembre, etc. Los valores mayores que 12
                referencian el mes apropiado en el/los año/s siguiente/s.
  <info>int</info>  <strong>$day</strong>     El número del día relativo al final del mes previo. Los valores del 1 al 28, 29, 30
                o 31 (dependiendo del mes) referencian los días normales del mes relevante. Los
                valores menores que 1 (incluyendo valores negativos) referencian los días del mes
                previo por lo que 0 es el último día del mes previo, -1 es el día anterior a ese,
                etc. Los valores mayores que el número de días del mes relevante referencian el día
                apropiado en el/los mes/es siguiente/s.
  <info>int</info>  <strong>$year</strong>    El número del año, puede ser un valor de dos o cuatro dígitos, con valores entre
                0-69 mapeados a 2000-2069 y 70-100 a 1970-2000. En sistemas donde time_t es un
                entero con signo de 32 bits, como es lo más normal hoy en día, el rango válido para
                <strong>$year</strong>  es entre 1901 y 2038. Sin embargo, antes de PHP 5.1.0 este rango estaba
                limitado desde 1970 a 2038 en algunos sistemas (p.ej. Windows).
  <info>int</info>  <strong>$is_dst</strong>  Este parámetro se puede establecer a 1 si el instante está durante el horario de
                verano (DST),  0 si no, o -1 (por omisión) si no se sabe si el instante está durante
                el horario de verano. Si no se sabe, PHP lo intentará calcular por sí mismo. Esto
                puede causar resultados inesperados (pero no incorrectos). Algunas veces no son
                válidos si DST está habilitado en el sistema donde se ejecuta PHP o  <strong>$is_dst</strong> está
                establecido a 1. Si DST está habilitado a, p.ej. 2:00, todas las horas entre las
                2:00 y las 3:00 no son válidas y <strong>mktime()</strong> devuelve un valor indefinido (normalmente
                negativo).  Algunos sistemas (p.ej. Solaris 8) habilitan DST a la medianoche por lo
                que la hora 0:30 del día, cuando DST está habilitado, es evaluada como 23:30 del día
                anterior.
                
                A partir de PHP 5.1.0, este parámetro se volvió obsoleto. Como resultado, se pueden
                usar en su lugar las nuevas características de manejo de zonas horarias.
                
                Este parámetro ha sido eliminado en PHP 7.0.0.

<comment>Return:</comment>
  <info>int</info>  <strong>mktime()</strong> devuelve la marca de tiempo Unix de los argumentos dados. Si los argumentos no son
       válidos, la función devuelve <info>false</info> (antes de PHP 5.1 devolvía <return>-1</return>).

<comment>See Also:</comment>
   * <strong>checkdate()</strong>
   * <strong>gmmktime()</strong>
   * <strong>date()</strong>
   * <strong>time()</strong>


id: money_format
type: function
doc:
<comment>Description:</comment>
  Da formato a un número como un string de moneda
  
  <strong>money_format()</strong> devuelve una versión de  <strong>$number</strong> con formato. Esta función se ajusta a la función
  <strong>strfmon()</strong> de la librería de C, con la diferencia de que esta aplicación convierte sólo un número a
  la vez.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  La especificación del formato se compone de la siguiente secuencia: un caracter
                   <return>%</return>indicadores opcionalesancho de campo opcionalprecisión a la izquierda
                   opcionalprecisión a la derecha opcionalun caracter de conversión obligatorio
                   
                   un caracter <return>%</return>
                   
                   indicadores opcionales
                   
                   ancho de campo opcional
                   
                   precisión a la izquierda opcional
                   
                   precisión a la derecha opcional
                   
                   un caracter de conversión obligatorio
                   
                   Uno o más de los siguientes indicadores opcionales pueden ser utilizados: <return>=</return>f El
                   caracter <return>=</return> seguido de un caracter f (byte único) que se utilizará como el
                   caracter de relleno numérico. El carácter de relleno por defecto es el espacio. <return>^</return>
                   Deshabilita el uso de caracteres de agrupamiento (según la definición de la
                   configuración regional actual). <return>+</return> o <return>(</return> Especifica el estilo de formato para los
                   números positivos y negativos. Si se utiliza <return>+</return>, el equivalente de la
                   configuración regional para <return>+</return> y <return>-</return> será usado. Si se utiliza <return>(</return>, las cantidades
                   negativas serán encerradas entre paréntesis. Si no se da ninguna especificación,
                   el valor por defecto es <return>+</return>. <return>!</return> Suprime el símbolo de moneda del string producido. <return>-</return>
                   Si está presente, hará todos los campos justificados a la izquierda (con relleno
                   a la derecha), contrario al valor por defecto que es para que los campos se
                   justifiquen a la derecha (con relleno a la izquierda).
                   
                   El caracter <return>=</return> seguido de un caracter f (byte único) que se utilizará como el
                   caracter de relleno numérico. El carácter de relleno por defecto es el espacio.
                   
                   Deshabilita el uso de caracteres de agrupamiento (según la definición de la
                   configuración regional actual).
                   
                   Especifica el estilo de formato para los números positivos y negativos. Si se
                   utiliza <return>+</return>, el equivalente de la configuración regional para <return>+</return> y <return>-</return> será usado. Si
                   se utiliza <return>(</return>, las cantidades negativas serán encerradas entre paréntesis. Si no
                   se da ninguna especificación, el valor por defecto es <return>+</return>.
                   
                   Suprime el símbolo de moneda del string producido.
                   
                   Si está presente, hará todos los campos justificados a la izquierda (con relleno
                   a la derecha), contrario al valor por defecto que es para que los campos se
                   justifiquen a la derecha (con relleno a la izquierda).
                   
                   w Un string de dígito decimal que especifica un ancho mínimo de campo. El campo
                   será justificado a la derecha a menos que el indicador <return>-</return> sea utilizado. El valor
                   por defecto es 0 (cero).
                   
                   Un string de dígito decimal que especifica un ancho mínimo de campo. El campo
                   será justificado a la derecha a menos que el indicador <return>-</return> sea utilizado. El valor
                   por defecto es 0 (cero).
                   
                   <return>#</return>n El número máximo de dígitos (n) que se espera a la izquierda del caracter
                   decimal (por ejemplo, el punto decimal). Es utilizado generalmente para mantener
                   la salida con formato alineada en las mismas columnas, usando el caracter de
                   relleno si el número de dígitos sea menor que n. Si el número de dígitos real es
                   mayor que n, entonces esta especificación es ignorada.  Si la agrupación no ha
                   sido suprimida mediante el indicador <return>^</return>, los separadores de agrupamiento serán
                   insertados antes de que los caracteres de relleno (si los hay) sean agregados.
                   Los separadores de agrupamiento no se aplicarán a los caracteres de relleno,
                   aunque el carácter de relleno sea un dígito.  Para asegurar la alineación,
                   cualquier caracter que aparezca antes o después del número en la salida con
                   formato, tales como símbolos de moneda o de signo, son rellenados cuando sea
                   necesario con caracteres de espacio para hacer sus formatos positivos y negativos
                   de una longitud igual.
                   
                   El número máximo de dígitos (n) que se espera a la izquierda del caracter decimal
                   (por ejemplo, el punto decimal). Es utilizado generalmente para mantener la
                   salida con formato alineada en las mismas columnas, usando el caracter de relleno
                   si el número de dígitos sea menor que n. Si el número de dígitos real es mayor
                   que n, entonces esta especificación es ignorada.
                   
                   Si la agrupación no ha sido suprimida mediante el indicador <return>^</return>, los separadores de
                   agrupamiento serán insertados antes de que los caracteres de relleno (si los hay)
                   sean agregados. Los separadores de agrupamiento no se aplicarán a los caracteres
                   de relleno, aunque el carácter de relleno sea un dígito.
                   
                   Para asegurar la alineación, cualquier caracter que aparezca antes o después del
                   número en la salida con formato, tales como símbolos de moneda o de signo, son
                   rellenados cuando sea necesario con caracteres de espacio para hacer sus formatos
                   positivos y negativos de una longitud igual.
                   
                   <return>.</return>p Un punto seguido por el número de dígitos (p) después del carácter decimal. Si
                   el valor de p es 0 (cero), el carácter decimal y los dígitos a su derecha serán
                   omitidos. Si no se incluye la precisión al la derecha, el valor por defecto será
                   dictado por la configuración regional actual en uso. La cantidad que se está
                   formateando se redondea al número especificado de dígitos antes de formatearla.
                   
                   Un punto seguido por el número de dígitos (p) después del carácter decimal. Si el
                   valor de p es 0 (cero), el carácter decimal y los dígitos a su derecha serán
                   omitidos. Si no se incluye la precisión al la derecha, el valor por defecto será
                   dictado por la configuración regional actual en uso. La cantidad que se está
                   formateando se redondea al número especificado de dígitos antes de formatearla.
                   
                   <return>i</return> El número se formatea de acuerdo al formato internacional de moneda de la
                   configuración regional (por ejemplo, para la configuración regional de EE.UU.:
                   USD $ 1,234.56). <return>n</return> El número se formatea de acuerdo al formato nacional de moneda
                   de la configuración regional (por ejemplo, para la configuración regional de_DE:
                   EU1.234,56). <return>%</return> Devuelve el caracter <return>%</return>.
                   
                   El número se formatea de acuerdo al formato internacional de moneda de la
                   configuración regional (por ejemplo, para la configuración regional de EE.UU.:
                   USD $ 1,234.56).
                   
                   El número se formatea de acuerdo al formato nacional de moneda de la
                   configuración regional (por ejemplo, para la configuración regional de_DE:
                   EU1.234,56).
                   
                   Devuelve el caracter <return>%</return>.
  <info>float</info>   <strong>$number</strong>  El número a ser formateado.

<comment>Return:</comment>
  <info>string</info>  Devuelve el string con formato. Los caracteres antes y después del string  de formato se
          devolverán sin cambios. Un <strong>$number</strong> no numérico causa que se devuelva <info>null</info> y se emite un
          <info>E_WARNING</info>.

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


