# php_manual

id: wincache_ocache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about opcode cache memory usage
    
  
  Retrieves information about memory usage by opcode cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about opcode cache memory usage  o <info>false</info> en caso de error
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the opcode cache <return>memory_free</return> - amount of free
               memory in bytes available for the opcode cache <return>num_used_blks</return> - number of memory
               blocks used by the opcode cache <return>num_free_blks</return> - number of free memory blocks
               available for the opcode cache <return>memory_overhead</return> - amount of memory in bytes used for
               the opcode cache internal structures
               
               <return>memory_total</return> - amount of memory in bytes allocated for the opcode cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the opcode cache
               
               <return>num_used_blks</return> - number of memory blocks used by the opcode cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the opcode cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the opcode cache internal
               structures
               
               Esta función fue
               ELILMINADA en PHP 7.0.0.

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_refresh_if_changed
type: function
doc:
<comment>Description:</comment>
  Refreshes the cache entries for the cached files
    
  
  Refreshes the cache entries for the files, whose names were passed in the input argument.  If no
  argument is specified then refreshes all the entries in the cache.

<comment>Param:</comment>
  <info>array</info>  <strong>$files</strong>  An array of file names for files that need to be refreshed.  An absolute or
                 relative file paths can be used.

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

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_rplist_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about resolve file path cache
    
  
  Retrieves information about cached mappings between relative file paths  and corresponding
  absolute file paths.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about the resolve file path cache  o <info>false</info> en caso de error
               
               The array returned by this function contains the following elements: <return>total_file_count</return>
               - total number of file path  mappings stored in the cache <return>rplist_entries</return> - an array
               that contains the information about all  the cached file paths: <return>resolve_path</return> - path
               to a file <return>subkey_data</return> - corresponding absolute path to a file
               
               <return>total_file_count</return> - total number of file path  mappings stored in the cache
               
               <return>rplist_entries</return> - an array that contains the information about all  the cached file
               paths: <return>resolve_path</return> - path to a file <return>subkey_data</return> - corresponding absolute path to a
               file
               
               <return>resolve_path</return> - path to a file
               
               <return>subkey_data</return> - corresponding absolute path to a file

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_rplist_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about memory usage by the resolve file path cache
    
  
  Retrieves information about memory usage by resolve file path cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data that describes memory usage by resolve file path cache.  o <info>false</info>
               en caso de error
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the resolve file path cache <return>memory_free</return> -
               amount of free memory in bytes available for the resolve file path cache
               <return>num_used_blks</return> - number of memory blocks used by the resolve file path cache
               <return>num_free_blks</return> - number of free memory blocks available for the resolve file path
               cache <return>memory_overhead</return> - amount of memory in bytes used for the internal structures of
               resolve file path cache
               
               <return>memory_total</return> - amount of memory in bytes allocated for the resolve file path cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the resolve file path
               cache
               
               <return>num_used_blks</return> - number of memory blocks used by the resolve file path cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the resolve file path
               cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the internal structures of
               resolve file path cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the session cache
    
  
  Retrieves information about session cache content and its usage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the session cache summary.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about session cache  o <info>false</info> en caso de error
               
               The array returned by this function contains the following elements:
               <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
               <return>total_item_count</return> - total number of elements that are currently in the session cache
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache <return>total_hit_count</return> - number of times the data has
               been served from the cache <return>total_miss_count</return> - number of times the data has not been
               found in the cache <return>scache_entries</return> - an array that contains the information about all
               the cached items: <return>key_name</return> - name of the key which is used to store the data
               <return>value_type</return> - type of value stored by the key <return>use_time</return> - time in seconds since the
               file has been accessed in the opcode cache <return>last_check</return> - time in seconds since the
               file has been checked for modifications <return>ttl_seconds</return> - time remaining for the data to
               live in the cache, 0 meaning infinite <return>age_seconds</return> - time elapsed from the time data
               has been added in the cache <return>hitcount</return> - number of times data has been served from the
               cache
               
               <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
               
               <return>total_item_count</return> - total number of elements that are currently in the session cache
               
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache
               
               <return>total_hit_count</return> - number of times the data has been served from the cache
               
               <return>total_miss_count</return> - number of times the data has not been found in the cache
               
               <return>scache_entries</return> - an array that contains the information about all the cached items:
               <return>key_name</return> - name of the key which is used to store the data <return>value_type</return> - type of value
               stored by the key <return>use_time</return> - time in seconds since the file has been accessed in the
               opcode cache <return>last_check</return> - time in seconds since the file has been checked for
               modifications <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0
               meaning infinite <return>age_seconds</return> - time elapsed from the time data has been added in the
               cache <return>hitcount</return> - number of times data has been served from the cache
               
               <return>key_name</return> - name of the key which is used to store the data
               
               <return>value_type</return> - type of value stored by the key
               
               <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
               
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               
               <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning infinite
               
               <return>age_seconds</return> - time elapsed from the time data has been added in the cache
               
               <return>hitcount</return> - number of times data has been served from the cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_meminfo
type: function
doc:
<comment>Description:</comment>
  Recupera información sobre el uso de memoria caché de sesión
    
  
  Recupera información sobre el uso de memoria caché de la sesión.

<comment>Return:</comment>
  <info>array|false</info>  Array de metadatos sobre el uso de la memoria caché de sesión  o <info>false</info> en caso de
               error
               
               El array devuelto por esta función contiene los siguientes elementos: <return>memory_total</return> -
               cantidad de memoria en bytes asignado para la caché de sesión <return>memory_free</return> - cantidad
               de memoria libre en bytes disponible para la caché de sesión <return>num_used_blks</return> - número
               de bloques de memoria utilizados por el caché de la sesión <return>num_free_blks</return> - número de
               bloques disponibles en la memoria de la caché de sesión <return>memory_overhead</return> - cantidad de
               memoria en bytes utilizado para las estructuras de sesión de caché interna
               
               <return>memory_total</return> - cantidad de memoria en bytes asignado para la caché de sesión
               
               <return>memory_free</return> - cantidad de memoria libre en bytes disponible para la caché de sesión
               
               <return>num_used_blks</return> - número de bloques de memoria utilizados por el caché de la sesión
               
               <return>num_free_blks</return> - número de bloques disponibles en la memoria de la caché de sesión
               
               <return>memory_overhead</return> - cantidad de memoria en bytes utilizado para las estructuras de
               sesión de caché interna

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ucache_add
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache only if variable does not already exist in the cache
    
  
  Adds a variable in user cache, only if this variable doesn't already exist in the cache.  The
  added variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     Store the variable using this <strong>$key</strong> name. If a variable with same key is already
                   present the function will fail and return <info>false</info>. <strong>$key</strong> is case sensitive. To
                   override the value even if  <strong>$key</strong> is present use <strong>wincache_ucache_set()</strong> function
                   instad.  <strong>$key</strong> can also take array of name =&gt; value pairs where names will be
                   used as keys.  This can be used to add multiple values in the cache in one
                   operation, thus avoiding race condition.
  <info>mixed</info>   <strong>$value</strong>   Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                   such as file handles. This paramter is ignored if first argument is an array. A
                   general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                   is an object, or an array containing objects, then the objects will be
                   serialized. See __sleep() for details on serializing objects.
  <info>array</info>   <strong>$values</strong>  Associative array of keys and values.
  <info>int</info>     <strong>$ttl</strong>     Time for the variable to live in the cache in seconds. After the value specified
                   in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                   parameter takes a default value of <return>0</return> which means  the variable will stay in the
                   cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                   <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_ucache_cas
type: function
doc:
<comment>Description:</comment>
  Compara la variable con el valor antiguo y le asigna un nuevo valor a este
    
  
  Compara la variable asociada con la <strong>$key</strong> con <strong>$old_value</strong>  y si coincide entonces asigna el
  <strong>$new_value</strong> a este.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>        El parámetro <strong>$key</strong> que se utiliza para almacenar la variable en la caché.  <strong>$key</strong>
                      distingue mayúsculas de minúsculas.
  <info>int</info>     <strong>$old_value</strong>  Valor anterior de la variable apuntada por <strong>$key</strong> en la memoria caché del
                      usuario. El valor debe ser de tipo <return>long</return>, en caso contrario la función devuelve
                      <info>false</info>.
  <info>int</info>     <strong>$new_value</strong>  El nuevo valor que se asigna a una variable New value which will get assigned
                      to variable indicado por la <strong>$key</strong> si se  encuentra una coincidencia. El valor
                      debe ser de tipo <return>long</return>, en caso contrario  la función devolverá <info>false</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>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_dec()</strong>


id: wincache_ucache_clear
type: function
doc:
<comment>Description:</comment>
  Elimina todo el contenido de la caché del usuario
    
  
  Borra o elimina todos los valores almacenados en la caché del 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>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_dec
type: function
doc:
<comment>Description:</comment>
  Disminuye el valor asociado a la clave
    
  
  Disminuye el valor asociado a la <strong>$key</strong> por 1 o como se especifica  por <strong>$dec_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      El parámetro <strong>$key</strong> que se utiliza para almacenar la variable en la caché.  <strong>$key</strong>
                    distingue mayúsculas de minúsculas.
  <info>int</info>     <strong>$dec_by</strong>   El valor de la variable asociada por el que conseguirá que <strong>$key</strong> disminuya.  Si
                    el argumento es un número de punto flotante se truncará al integer más cercano.
                    La variable asociada  con la <strong>$key</strong> debe ser de tipo <return>long</return>, en caso contrario  la
                    función falla y devolverá <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Será establecido a <info>true</info> en caso de éxito y <info>false</info> en caso de error.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor decrementado en caso de éxito y <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_delete
type: function
doc:
<comment>Description:</comment>
  Elimina las variables de la memoria caché del usuario
    
  
  Elimina los elementos de la caché del usuario apuntado por <strong>$key</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  El parámetro <strong>$key</strong> que se utiliza para almacenar la variable en la caché. <strong>$key</strong>
               distingue mayúsculas de minúsculas. <strong>$key</strong> puede ser un  array de claves.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.
        
        Si <strong>$key</strong> es un array, entonces la función devuelve <info>false</info>  si cada elemento del array no se
        borra de la memoria caché del usuario, en caso contrario devuelve un  array que consta de
        todas las claves que se eliminan.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_exists
type: function
doc:
<comment>Description:</comment>
  Comprueba si una variable existe en la caché del usuario
    
  
  Comprueba si una variable con la <strong>$key</strong> existe en la caché de usuario o no.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  La <strong>$key</strong> que se utiliza para almacenar la variable en la caché.  <strong>$key</strong> distingue
                mayúsculas de minúsculas.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la variable con la <strong>$key</strong> existe,  en caso contrario devuelve <info>false</info>.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_get
type: function
doc:
<comment>Description:</comment>
  Obtiene una variable almacenada en la caché del usuario
    
  
  Obtiene una variable almacenada en la caché del usuario.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      La <strong>$key</strong> que se utiliza para almacenar la variable en la caché.  <strong>$key</strong> distingue
                   mayúsculas de minúsculas. <strong>$key</strong> puede ser  un array de claves. En este caso el
                   valor de retorno será un array de valores de cada elemento en el array <strong>$key</strong>. Si
                   un objeto, o un array que contiene objetos, es retornado, entonces los objetos
                   serán decodificados. Véase __wakeup() para más detalles sobre decodificar
                   objetos.
  <info>bool</info>   <strong>$success</strong>  Se establecerá en <info>true</info> en caso de éxito y <info>false</info> en caso de error.

<comment>Return:</comment>
  <info>mixed</info>  Si <strong>$key</strong> es un string, la función devuelve el valor de la variable almacenada con esa clave.
         El parámetro <strong>$success</strong> es establecido a <info>true</info> en caso de éxito y  a <info>false</info> en caso de error.
         
         El parámetro <strong>$key</strong> es un array, el parámetro <strong>$success</strong>  siempre se establece en <info>true</info>. El
         array devuelto (pares nombre =&gt; valor) will  contendrá sólo aquellos pares nombre =&gt;
         valor en donde la operación de obtención de caché de  usuario se ha realizado
         correctamente. Si ninguna de las claves del array encuentran una coincidencia  en la caché
         del usuario, un array vacío será devuelto.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __wakeup()


id: wincache_ucache_inc
type: function
doc:
<comment>Description:</comment>
  Incrementa el valor asociado a la clave
    
  
  Incrementa el valor asociado a la <strong>$key</strong> por 1 o como se especifica  por <strong>$inc_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      La <strong>$key</strong> que se utiliza para almacenar la variable en la caché. <strong>$key</strong> distingue
                    mayúsculas de minúsculas.
  <info>int</info>     <strong>$inc_by</strong>   El valor por el cual la variable asociada con la <strong>$key</strong> será incrementada.  Si el
                    argumento es un número de punto flotante se truncará al integer más cercano. La
                    variable  asociada con la <strong>$key</strong> debe ser de tipo <return>long</return>, de lo contrario  la
                    función falla y devuelve <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Se establecerá en <info>true</info> en caso de éxito y <info>false</info> en caso de error.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor incrementado en caso de éxito y <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>wincache_ucache_dec()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_info
type: function
doc:
<comment>Description:</comment>
  Recupera información sobre los datos almacenados en la caché del usuario
    
  
  Recupera información sobre los datos almacenados en la caché del usuario.

<comment>Param:</comment>
  <info>bool</info>    <strong>$summaryonly</strong>  Controla si el array devuelto contiene información sobre las entradas de
                        caché individuales junto con el resumen caché del usuario.
  <info>string</info>  <strong>$key</strong>          La clave de una entrada en la caché del usuario. Si se especifica a
                        continuación, el array devuelto contendrá información sólo acerca de que la
                        entrada de caché. Si no se especifica y <strong>$summaryonly</strong> es establecido a <info>false</info>
                        entonces el array devuelto contendrá información sobre todas las entradas en
                        la caché.

<comment>Return:</comment>
  <info>array|false</info>  Array de metadatos sobre caché de usuario  o <info>false</info> en caso de error
               
               El array devuelto por esta función contiene los siguientes elementos:
               <return>total_cache_uptime</return> - tiempo total en segundos que el caché de usuario ha sido activo
               <return>total_item_count</return> - número total de elementos que están actualmente en la caché del
               usuario <return>is_local_cache</return> - true si el caché es de metadatos para una instancia de caché
               local, false si los metadatos es para el la caché global <return>total_hit_count</return> - número de
               veces que los datos se han servido de la memoria caché <return>total_miss_count</return> - número de
               veces que los datos no se han encontrado en la caché <return>ucache_entries</return> - un array que
               contiene la información sobre todos los elementos almacenados en caché: <return>key_name</return> -
               nombre de la clave que se utiliza para almacenar los datos <return>value_type</return> - tipo de valor
               almacenado por la clave <return>use_time</return> - tiempo en segundos desde el fichero ha sido
               visitado en la caché de código de operación <return>last_check</return> - tiempo en segundos desde el
               fichero ha sido chequeado para modificaciones <return>is_session</return> - indica si los datos son
               una variable de sesión <return>ttl_seconds</return> - el tiempo restante de los datos a vivir en la
               memoria caché, 0 significa infinito <return>age_seconds</return> - tiempo transcurrido desde el
               momento que los datos han sido añadidos en la caché <return>hitcount</return> - número de veces que
               los datos se han servido de la memoria caché
               
               <return>total_cache_uptime</return> - tiempo total en segundos que el caché de usuario ha sido activo
               
               <return>total_item_count</return> - número total de elementos que están actualmente en la caché del
               usuario
               
               <return>is_local_cache</return> - true si el caché es de metadatos para una instancia de caché local,
               false si los metadatos es para el la caché global
               
               <return>total_hit_count</return> - número de veces que los datos se han servido de la memoria caché
               
               <return>total_miss_count</return> - número de veces que los datos no se han encontrado en la caché
               
               <return>ucache_entries</return> - un array que contiene la información sobre todos los elementos
               almacenados en caché: <return>key_name</return> - nombre de la clave que se utiliza para almacenar los
               datos <return>value_type</return> - tipo de valor almacenado por la clave <return>use_time</return> - tiempo en
               segundos desde el fichero ha sido visitado en la caché de código de operación
               <return>last_check</return> - tiempo en segundos desde el fichero ha sido chequeado para
               modificaciones <return>is_session</return> - indica si los datos son una variable de sesión
               <return>ttl_seconds</return> - el tiempo restante de los datos a vivir en la memoria caché, 0
               significa infinito <return>age_seconds</return> - tiempo transcurrido desde el momento que los datos
               han sido añadidos en la caché <return>hitcount</return> - número de veces que los datos se han servido
               de la memoria caché
               
               <return>key_name</return> - nombre de la clave que se utiliza para almacenar los datos
               
               <return>value_type</return> - tipo de valor almacenado por la clave
               
               <return>use_time</return> - tiempo en segundos desde el fichero ha sido visitado en la caché de código
               de operación
               
               <return>last_check</return> - tiempo en segundos desde el fichero ha sido chequeado para
               modificaciones
               
               <return>is_session</return> - indica si los datos son una variable de sesión
               
               <return>ttl_seconds</return> - el tiempo restante de los datos a vivir en la memoria caché, 0
               significa infinito
               
               <return>age_seconds</return> - tiempo transcurrido desde el momento que los datos han sido añadidos en
               la caché
               
               <return>hitcount</return> - número de veces que los datos se han servido de la memoria caché

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_meminfo
type: function
doc:
<comment>Description:</comment>
  Recupera información sobre el uso de memoria caché de usuario
    
  
  Recupera información sobre el uso de memoria caché del usuario.

<comment>Return:</comment>
  <info>array|false</info>  Array de metadatos sobre el uso de la memoria caché de usuario  o <info>false</info> en caso de
               error
               
               El array devuelto por esta función contiene los siguientes elementos: <return>memory_total</return> -
               cantidad de memoria en bytes asignado para la caché de usuario <return>memory_free</return> - cantidad
               de memoria libre en bytes disponible para la caché de usuario <return>num_used_blks</return> - número
               de bloques de memoria utilizados por el caché del usuario <return>num_free_blks</return> - número de
               bloques disponibles en la memoria de la caché del usuario <return>memory_overhead</return> - cantidad
               de memoria en bytes utilizado para las estructuras de los usuarios de caché interna
               
               <return>memory_total</return> - cantidad de memoria en bytes asignado para la caché de usuario
               
               <return>memory_free</return> - cantidad de memoria libre en bytes disponible para la caché de usuario
               
               <return>num_used_blks</return> - número de bloques de memoria utilizados por el caché del usuario
               
               <return>num_free_blks</return> - número de bloques disponibles en la memoria de la caché del usuario
               
               <return>memory_overhead</return> - cantidad de memoria en bytes utilizado para las estructuras de los
               usuarios de caché interna

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_set
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache and overwrites a variable if it already exists in the cache
    
  
  Adds a variable in user cache. Overwrites a variable if it already exists in the cache.  The added
  or updated variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>     Store the variable using this <strong>$key</strong> name. If a variable with same  <strong>$key</strong> is already
                  present the function will overwrite the previous  value with the new one. <strong>$key</strong> is
                  case sensitive.  <strong>$key</strong> can also take array of name =&gt; value pairs where names
                  will be used as  keys. This can be used to add multiple values in the cache in one
                  operation, thus avoiding  race condition.
  <info>mixed</info>  <strong>$value</strong>   Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                  such as file handles. This paramter is ignored if first argument is an array. A
                  general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                  is an object, or an array containing objects, then the objects will be serialized.
                  See __sleep() for details on serializing objects.
  <info>array</info>  <strong>$values</strong>  Associative array of keys and values.
  <info>int</info>    <strong>$ttl</strong>     Time for the variable to live in the cache in seconds. After the value specified
                  in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                  parameter takes a default value of <return>0</return> which means  the variable will stay in the
                  cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                  <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_unlock
type: function
doc:
<comment>Description:</comment>
  Libera un bloqueo exclusivo sobre una clave dada
    
  
  Libera un bloqueo exclusivo que se obtuvo en una clave dada mediante <strong>wincache_lock()</strong>.  Si
  cualquier otro proceso fue bloqueado en espera de el bloqueo en esta clave, este proceso será
  capaz de  obtener el bloqueo.
  
  Usando <strong>wincache_lock()</strong> y <strong>wincache_unlock()</strong> puede causar bloqueos al  ejecutar los scripts PHP en
  un entorno de multi-proceso, como FastCGI. No utilice estas funciones a menos  que esté
  absolutamente seguro de que necesitan para su uso. Para la mayoría de las operaciones en la caché
  de usuario no es necesario el uso de estas funciones.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Nombre de la llave en la caché para liberar el bloqueo.

<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>wincache_lock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wkhtmltox\Image\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Image converter
  
  Creates an Image converter, optionally taking an input buffer and configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangeloginURL or path of the input file, if "-" stdin is
                     used/path/to/markup.html&gt;= 0.1.0outpath of output file, if "-" stdout is
                     used, by default an internal buffer is used/path/to/output.png&gt;=
                     0.1.0fmtoutput format to use""defaultjpgoutput as JPEGpngoutput as PNGbmpoutput
                     as bitmapsvgoutput as SVG&gt;= 0.1.0transparentwhen outputting a PNG or SVG,
                     make the white background transparentboolean&gt;= 0.1.0screenWidththe with of
                     the screen used to render in pixels800&gt;= 0.1.0smartWidthwhen true,
                     screenWidth is expanded to the content widthboolean&gt;=
                     0.1.0qualitycompression factor to use when outputting a JPEG image94&gt;=
                     0.1.0crop.leftleft/x coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.toptop/y coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.widthwidth of the window to capture in pixels200&gt;=
                     0.1.0crop.heightheight of the window to capture in pixels200&gt;=
                     0.1.0load.cookieJarpath of file used to load and store
                     cookies/tmp/cookies.txt&gt;= 0.1.0load.usernameuser name to use when loging
                     into a websitebart&gt;= 0.1.0load.passwordthe password to used when logging
                     into a websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds
                     to wait after a page is loaded until it is captured1200&gt;=
                     0.1.0load.zoomFactorhow much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wkhtmltox\Image\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Realiza la conversión de la imagen
  
  Realiza la conversión de la memoria intermedia de entrada

<comment>Return:</comment>
  <info>string|null</info>  Cuando se utilice el valor de retorno, se rellenará con el contenido de la memoria
               intermedia de conversión


id: wkhtmltox\Image\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determina la versión del convertidor
  
  Determina la versión del convertidor según lo informado por libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Devuelve un string de versión
          
          Esto todavía no se ha implementado por libwkhtmltox


id: wkhtmltox\PDF\Converter
type: class
doc:
<comment>Description:</comment>
  Convierte una entrada HTML, o un conjunto de entradas HTML, en una salida PDF


id: wkhtmltox\PDF\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF converter
  
  Creates a PDF converter, using optional configuration settings

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  NameDescriptionValuesChangelogsize.pageSizepaper size of output documentA4&gt;=
                    0.1.0size.widthwith of the output document210mm&gt;= 0.1.0size.heightheight of
                    the output document297mm&gt;= 0.1.0orientationorientation of the output
                    documentLandscapePortrait&gt;= 0.1.0colorModecolor mode of the output
                    documentColorGreyscale&gt;= 0.1.0resolutionresoluition of the output
                    documentmost likely has no effect&gt;= 0.1.0dpidpi to use while printing80&gt;=
                    0.1.0pageOffsetinteger added to page numbers generating headers, footers, and
                    toc&gt;= 0.1.0copies&gt;= 0.1.0collatecollate copiesboolean&gt;=
                    0.1.0outlinegenerate PDF outlineboolean&gt;= 0.1.0outlineDepthmaximum depth of
                    outline&gt;= 0.1.0dumpOutlinepath of file to dump outline XML&gt;= 0.1.0outpath
                    of output file, if "-" stdout is used&gt;= 0.1.0documentTitletitle for the
                    output document&gt;= 0.1.0useCompressionenable or disable lossless
                    compressionboolean&gt;= 0.1.0margin.topsize of the top margin2cm&gt;=
                    0.1.0margin.bottomsize of the bottom margin2cm&gt;= 0.1.0margin.leftsize of the
                    left margin2cm&gt;= 0.1.0margin.rightsize of the right margin2cm&gt;=
                    0.1.0imageDPImaximum DPI for images in the output document&gt;=
                    0.1.0imageQualitythe jpeg compression factor for images in the output
                    document94&gt;= 0.1.0load.cookieJarpath of file used to load and store
                    cookies/tmp/cookies.txt&gt;= 0.1.0


id: wkhtmltox\PDF\Converter::add
type: function
doc:
<comment>Description:</comment>
  Añade un objeto para su conversión
  
  Añade el objeto dado a la conversión

<comment>Param:</comment>
  <info>wkhtmltox\PDF\Object</info>  <strong>$object</strong>  El objeto a añadir

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


id: wkhtmltox\PDF\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Realiza la conversión a PDF
  
  Realiza la conversión de todos los objetos añadidos anteriormente

<comment>Return:</comment>
  <info>string|null</info>  Donde se utiliza el valor de retorno, se llenará con el contenido del buffer de
               conversión


id: wkhtmltox\PDF\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determina la versión del convertidor
  
  Determina la versión del convertidor según lo informado por libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Devuelve un string de versión


id: wkhtmltox\PDF\Object::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF Object
  
  Creates a new PDF Object from the given buffer and optional configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangelogpageURL or path of the HTML to convert&gt;=
                     0.1.0useExternalLinksset true to convert external links in the input into
                     external PDF links in the outputboolean&gt;= 0.1.0useLocalLinksset true to
                     convert internal links in the input into internal PDF links in the
                     outputboolean&gt;= 0.1.0produceFormsset true to turn HTML forms into PDF
                     formsboolean&gt;= 0.1.0replacementsundocumented&gt;= 0.1.0includeInOutlineset
                     true to include sections from this object in the outline and tocboolean&gt;=
                     0.1.0pagesCountset true to make page count in toc inclusive of the number of
                     pages in this objectboolean&gt;= 0.1.0tocXslset to style sheet to convert this
                     object into a toc object&gt;= 0.1.0toc.useDottedLinesset true to use dotted
                     lines in tocboolean&gt;= 0.1.0toc.captionTextthe caption text for toc&gt;=
                     0.1.0toc.forwardLinksset true to create links from toc to contentboolean&gt;=
                     0.1.0toc.backLinksset true to create links from content to tocboolean&gt;=
                     0.1.0toc.indentationindentation for toc2em&gt;= 0.1.0toc.fontScalethe factor to
                     scale down the font at every toc level0.8&gt;= 0.1.0header.fontSizefont size
                     for use in header13&gt;= 0.1.0header.fontNamename of font for use in
                     headertimes&gt;= 0.1.0header.lefttext for left of header&gt;=
                     0.1.0header.centertext for center of header&gt;= 0.1.0header.righttext for
                     right of header&gt;= 0.1.0header.lineenable or disable horizontal rule under
                     headerboolean&gt;= 0.1.0header.spacingspace between header and content1.8&gt;=
                     0.1.0header.htmlUrlURL or path of HTML to use in header&gt;=
                     0.1.0footer.fontSizefont size for use in footer13&gt;= 0.1.0footer.fontNamename
                     of font for use in footertimes&gt;= 0.1.0footer.lefttext for left of
                     footer&gt;= 0.1.0footer.centertext for center of footer&gt;=
                     0.1.0footer.righttext for right of footer&gt;= 0.1.0footer.lineenable or
                     disable horizontal rule under footerboolean&gt;= 0.1.0footer.spacingspace
                     between footer and content1.8&gt;= 0.1.0footer.htmlUrlURL or path of HTML to
                     use in footer&gt;= 0.1.0load.usernameuser name to use when loging into a
                     websitebart&gt;= 0.1.0load.passwordthe password to used when logging into a
                     websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds to wait
                     after a page is loaded until it is captured1200&gt;= 0.1.0load.zoomFactorhow
                     much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wordwrap
type: function
doc:
<comment>Description:</comment>
  Ajusta un string hasta un número dado de caracteres
  
  Ajusta un string hasta un número dado de caracteres utilizando un caracter de salto de string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    El string de entrada.
  <info>int</info>     <strong>$width</strong>  El número de caracteres en el cual el string se verá envuelto.
  <info>string</info>  <strong>$break</strong>  La línea se rompe utilizando el parámetro opcional <strong>$break</strong>.
  <info>bool</info>    <strong>$cut</strong>    Si <strong>$cut</strong> se establece en <info>true</info>, el string siempre será ajustado en o antes del
                  <strong>$width</strong> especificado. De tal forma que si se tiene una palabra que es más larga que
                  el ancho dado, será dividida (ver segundo ejemplo). Cuando es <info>false</info> la función no
                  divide la palabra incluso si <strong>$width</strong> es menor que el ancho de la palabra.

<comment>Return:</comment>
  <info>string</info>  Devuelve el string dado ajustado a la longitud especificada.

<comment>See Also:</comment>
   * <strong>nl2br()</strong>
   * <strong>chunk_split()</strong>


id: xattr_get
type: function
doc:
<comment>Description:</comment>
  Obtener un atributo extendido
    
  
  Esta función obtiene el valor de un atributo extendido del archivo.
  
  Los atributos extendidos tienen dos espacios de nombres diferentes: de usuario
  y raíz. El  de usuario está disponible para todos los usuarios, mientras que el espacio de nombres
  raíz
  está disponible sólo para usuarios con privilegios root. xattr opera en el espacio de nombres
  de usuario por defecto, pero esto puede ser cambiado con el parámetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El archivo de la cual obtenemos el atributo.
  <info>string</info>  <strong>$name</strong>      El nombre del atributo.
  <info>int</info>     <strong>$flags</strong>     Banderas xattr soportadas<info>XATTR_DONTFOLLOW</info>No sigue el enlace simbólico pero se
                     puede operar en este.<info>XATTR_ROOT</info> Establece atributos en la raíz (segura) de
                     espacio de nombres. Requiere privilegios de administrador.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string que contiene el valor o <info>false</info> si el atributo no existe.

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_list
type: function
doc:
<comment>Description:</comment>
  Obtener una lista de atributos extendidos
    
  
  Esta función obtiene una lista de nombres de los atributos extendidos de un archivo.
  
  Los atributos extendidos tienen dos espacios de nombres diferentes: de usuario
  y raíz. El  de usuario está disponible para todos los usuarios, mientras que el espacio de nombres
  raíz
  está disponible sólo para usuarios con privilegios root. xattr opera en el espacio de nombres
  de usuario por defecto, pero esto puede ser cambiado con el parámetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta del archivo.
  <info>int</info>     <strong>$flags</strong>     Banderas xattr soportadas<info>XATTR_DONTFOLLOW</info>No sigue el enlace simbólico pero se
                     puede operar en este.<info>XATTR_ROOT</info> Establece atributos en la raíz (segura) de
                     espacio de nombres.  Requiere privilegios de administrador.

<comment>Return:</comment>
  <info>array</info>  Esta función devuelve un array con los nombres de los atributos extendidos.

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


id: xattr_remove
type: function
doc:
<comment>Description:</comment>
  Elimina un atributo extendido
    
  
  Esta función elimina un atributo extendido del archivo.
  
  Los atributos extendidos tienen dos espacios de nombres diferentes: de usuario
  y raíz. El  de usuario está disponible para todos los usuarios, mientras que el espacio de nombres
  raíz
  está disponible sólo para usuarios con privilegios root. xattr opera en el espacio de nombres
  de usuario por defecto, pero esto puede ser cambiado con el parámetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El archivo del que se elimina el atributo.
  <info>string</info>  <strong>$name</strong>      El nombre del atributo a eliminar.
  <info>int</info>     <strong>$flags</strong>     Banderas xattr soportadas<info>XATTR_DONTFOLLOW</info>No sigue el enlace simbólico pero se
                     puede operar en este.<info>XATTR_ROOT</info> Establece atributos en la raíz (segura) de
                     espacio de nombres. Requiere privilegios de  administrador.

<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>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_get()</strong>


id: xattr_set
type: function
doc:
<comment>Description:</comment>
  Establece un atributo extendido
    
  
  Esta función establece el valor de un atributo extendido del archivo.
  
  Los atributos extendidos tienen dos espacios de nombres diferentes: de usuario
  y raíz. El  de usuario está disponible para todos los usuarios, mientras que el espacio de nombres
  raíz
  está disponible sólo para usuarios con privilegios root. xattr opera en el espacio de nombres
  de usuario por defecto, pero esto puede ser cambiado con el parámetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El archivo en el que se establece el atributo.
  <info>string</info>  <strong>$name</strong>      El nombre del atributo extendido. Este atributo se crea si no existe  o
                     reemplazado si ya existe. Puede cambiar este comportamiento mediante  el uso de
                     los parámetros <strong>$flags</strong>.
  <info>string</info>  <strong>$value</strong>     El valor del atributo.
  <info>int</info>     <strong>$flags</strong>     Banderas xattr soportadas<info>XATTR_CREATE</info>La función falla si el atributo extendido
                     ya existe.<info>XATTR_REPLACE</info>La función falla si el atributo extendido no
                     existe.<info>XATTR_DONTFOLLOW</info>No sigue el enlace simbólico pero se puede operar en
                     este.<info>XATTR_ROOT</info> Establece atributos en la raíz (segura) de espacio de nombres.
                     Requiere privilegios de administrador.

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


id: xattr_supported
type: function
doc:
<comment>Description:</comment>
  Comprueba si soporta los atributos extendidos del sistema de archivos
    
  
  Esta función comprueba si el sistema de archivos que contenía el fichero dado soporta  los
  atributos extendidos. Es necesario tener acceso de lectura al archivo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta del archivo de prueba.
  <info>int</info>     <strong>$flags</strong>     Banderas xattr soportadas<info>XATTR_DONTFOLLOW</info>No sigue el enlace simbólico pero se
                     puede operar en este.

<comment>Return:</comment>
  <info>bool</info>  Esta función devuelve <info>true</info> si sistema de archivo soporta los atributos extendidos, <info>false</info> si
        no soporta y <info>null</info> si no se puede determinar (Por ejemplo  ruta incorrecta o le faltan
        permisos al archivo).

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_list()</strong>


id: xdiff_file_bdiff
type: function
doc:
<comment>Description:</comment>
  Realiza una diferencia binaria de dos archivos
  
  Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión.
  Esta función trabaja con archivos de texto y binarios. El archivo parche resultante puede ser
  aplicado posteriormente utilizando <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Ruta a el primer archivo. Este archivo actúa como "viejo" archivo.
  <info>string</info>  <strong>$new_file</strong>  Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo.
  <info>string</info>  <strong>$dest</strong>      Ruta de el archivo parche resultante. El archivo resultante contiene
                     diferencias entre los archivos "viejo" y "nuevo". Este será en formato binario
                     y no leible por humanos.

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


id: xdiff_file_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Lee el tamaño de un archivo creado tras aplicar una diferencia binaria
  
  Devuelve el tamaño de un archivo resultado que se creó después de aplicar el parche binario desde
  el archivo <strong>$file</strong> a el archivo original.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  La ruta al parche binario creado por la función <strong>xdiff_string_bdiff()</strong> o
                 <strong>xdiff_string_rabdiff()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el tamaño del archivo que se creará.

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bpatch
type: function
doc:
<comment>Description:</comment>
  Parchea un archivo con una diferencia binaria
  
  Parchea un <strong>$file</strong> con un <strong>$patch</strong> binario y almacena el resultado en un archivo <strong>$dest</strong>.  Esta función
  acepta parches creados tanto a través de la funciones <strong>xdiff_file_bdiff()</strong>  y <strong>xdiff_file_rabdiff()</strong>
  como de sus equivalentes de cadena.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   El archivo original.
  <info>string</info>  <strong>$patch</strong>  El archivo parche binario.
  <info>string</info>  <strong>$dest</strong>   La ruta del archivo resultante.

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


id: xdiff_file_diff
type: function
doc:
<comment>Description:</comment>
  Hacer un diff unificado de dos archivos
  
  Hace un diff unificado que contiene las diferencias entre <strong>$old_file</strong> y <strong>$new_file</strong> y almacena este en
  el archivo <strong>$dest</strong>. El archivo resultante es legible. Un parámetro opcional <strong>$context</strong> especifica el
  número de líneas de contexto que hay que añadir alrededor de cada cambio. Establecer el parámetro
  <strong>$minimal</strong> a true dará como resultado de salida el archivo parche más corto posible (puede tomar
  algo de tiempo).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Ruta a el primer archivo. Este archivo actúa como "viejo" archivo.
  <info>string</info>  <strong>$new_file</strong>  Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo.
  <info>string</info>  <strong>$dest</strong>      Ruta del archivo parche resultante.
  <info>int</info>     <strong>$context</strong>   Indica el número de líneas de contexto que desea incluir en el resultado diff.
  <info>bool</info>    <strong>$minimal</strong>   Establezca este parámetro a <info>true</info> si desea reducir el tamaño del resultado
                     (puede tomar algo de tiempo).

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


id: xdiff_file_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_file_bdiff
  
  Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión.
  Esta función trabaja con archivos de texto y binarios. El archivo parche resultante puede ser
  posteriormente aplicado con <strong>xdiff_file_bpatch()</strong>.
  
  Desde la versión 1.5.0 de esta función es un alias de <strong>xdiff_file_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Ruta a el primer archivo. Este archivo actúa como "viejo" archivo.
  <info>string</info>  <strong>$new_file</strong>  Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo.
  <info>string</info>  <strong>$dest</strong>      Ruta de el archivo parche resultante. El archivo resultante contiene
                     diferencias entre los archivos "viejo" y "nuevo". Este será en formato binario
                     y no legible por humanos.

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


id: xdiff_file_merge3
type: function
doc:
<comment>Description:</comment>
  Une 3 archivos en uno
  
  Une tres archivos en uno y almacena el resultado en un archivo <strong>$dest</strong>.  El <strong>$old_file</strong> es una versión
  original mientras <strong>$new_file1</strong> y <strong>$new_file2</strong> son versiones modificadas de un original.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>   Ruta a el primer archivo. Este archivo actúa como "viejo" archivo.
  <info>string</info>  <strong>$new_file1</strong>  Ruta a el segundo archivo. Este actúa como una versión modificada de
                      <strong>$old_file</strong>.
  <info>string</info>  <strong>$new_file2</strong>  Ruta a el tercer archivo. Este actúa como una versión modificada de <strong>$old_file</strong>.
  <info>string</info>  <strong>$dest</strong>       La ruta del archivo resultante, contiene la unión modificada de <strong>$new_file1</strong> y
                      <strong>$new_file2</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> si la unión fue satisfactoria, una cadena con fragmento erróneo si esta no lo
         fue o <info>false</info> si ocurrió un error interno.

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


id: xdiff_file_patch
type: function
doc:
<comment>Description:</comment>
  Parchea un archivo con un diff unificado
  
  Parchea un <strong>$file</strong> con un <strong>$patch</strong> y almacena el resultado en un archivo. <strong>$patch</strong> tiene que ser un diff
  unificado creado por la función <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong>.  Un parámetro opcional
  <strong>$flags</strong> especifica el modo de operación.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   El archivo original.
  <info>string</info>  <strong>$patch</strong>  El archivo de revisión unificado. Este tiene que ser creado con las funciones
                  <strong>xdiff_string_diff()</strong>,  <strong>xdiff_file_diff()</strong> o herramientas compatibles.
  <info>string</info>  <strong>$dest</strong>   Ruta de el archivo resultante.
  <info>int</info>     <strong>$flags</strong>  Puede ser <info>XDIFF_PATCH_NORMAL</info> (modo por defecto, parche normal) o
                  <info>XDIFF_PATCH_REVERSE</info> (parche invertido).
                  
                  A partir de la versión 1.5.0, también puede utilizar binario OR para habilitar el
                  indicador <info>XDIFF_PATCH_IGNORESPACE</info>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>false</info> si ocurrió un error interno, una cadena con fragmento erróneo si el parche
         no pudo ser aplicado o <info>true</info> si el parche fue aplicado con éxito.

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


id: xdiff_file_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_file_bpatch
  
  Parchea un <strong>$file</strong> con un <strong>$patch</strong> binario y almacena el resultado en un archivo <strong>$dest</strong>. Esta función
  acepta parches creados tanto a través de funciones <strong>xdiff_file_bdiff()</strong> o <strong>xdiff_file_rabdiff()</strong> como
  de sus equivalentes de cadena.
  
  Desde la versión 1.5.0 esta función es un alias de <strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   El archivo original.
  <info>string</info>  <strong>$patch</strong>  El archivo parche binario.
  <info>string</info>  <strong>$dest</strong>   La ruta de el archivo resultante.

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


id: xdiff_file_rabdiff
type: function
doc:
<comment>Description:</comment>
  Hacer una diferencia binaria de dos archivos utilizando el algoritmo polinomial de huella digital
  (fingerprinting) de Rabin
  
  Hace una diferencia binaria de dos archivos y almacena el resultado en un archivo de revisión. La
  diferencia entre esta función y <strong>xdiff_file_bdiff()</strong> es el diferente algoritmo que se utiliza que
  debería traducirse en una ejecución más rápida y un diff producido menor. Esta función trabaja con
  archivos de texto y binarios. El archivo parche resultante puede ser posteriormente aplicado
  utilizando <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.
  
  Para obtener más información sobre las diferencias entre el algoritmo utilizado por favor vea el
  sitio web libxdiff

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Ruta a el primer archivo. Este archivo actúa como "viejo" archivo.
  <info>string</info>  <strong>$new_file</strong>  Ruta a el segundo archivo. Este archivo actúa como "nuevo" archivo.
  <info>string</info>  <strong>$dest</strong>      Ruta de el archivo parche resultante. El archivo resultante contiene
                     diferencias entre  los archivos "viejo" y "nuevo". Este será en formato binario
                     y no legible por humanos.

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


id: xdiff_string_bdiff
type: function
doc:
<comment>Description:</comment>
  Hacer una diferencia binaria de dos cadenas
  
  Hace una diferencia binaria de dos cadenas y devuelve el resultado. Esta función trabaja con texto
  y datos binarios. El parche resultante puede ser posteriormente aplicado utilizando
  <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Primera cadena con información binaria. Esta actúa como "vieja" información.
  <info>string</info>  <strong>$new_data</strong>  Segunda cadena con información binaria. Esta actúa como "nueva" información.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena con la diferencia binaria conteniendo las diferencias entre "vieja" y
          "nueva" información o <info>false</info> si se producido un error interno.

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


id: xdiff_string_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Lee el tamaño de un archivo creado tras aplicar una diferencia binaria
  
  Devuelve el tamaño de un archivo resultante que será creado tras aplicar el <strong>$patch</strong> binario a el
  archivo original.

<comment>Param:</comment>
  <info>string</info>  <strong>$patch</strong>  El parche binario creado por la función <strong>xdiff_string_bdiff()</strong> o
                  <strong>xdiff_string_rabdiff()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el tamaño del archivo que fue creado.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bpatch
type: function
doc:
<comment>Description:</comment>
  Parchear una cadena con una diferencia binaria
  
  Parchea una cadena <strong>$str</strong> con un <strong>$patch</strong> binario. Esta función acepta parches creados tanto a través
  de las funciones <strong>xdiff_string_bdiff()</strong>  y <strong>xdiff_string_rabdiff()</strong> o su archivo homólogo equivalente.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La cadena binaria original.
  <info>string</info>  <strong>$patch</strong>  La cadena parche binaria.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena parcheada, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_diff
type: function
doc:
<comment>Description:</comment>
  Hacer un diff unificado de dos strings
  
  Hace un diff unificado que contiene diferencias entre el string <strong>$old_data</strong> y el string <strong>$new_data</strong> y
  devuelve este. El diff resultante es legible. Un parámetro opcional <strong>$context</strong> especifica el número
  de líneas de contexto que hay que añadir alrededor de cada cambio. Establecer el parámetro
  <strong>$minimal</strong> a true dará como resultado de salida el archivo parche más corto posible (puede tomar
  algo de tiempo).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Primera cadena con información. Esta actúa como "vieja" información.
  <info>string</info>  <strong>$new_data</strong>  Segundo string con información. Esta actúa como "nueva" información.
  <info>int</info>     <strong>$context</strong>   Indica el número de líneas de contexto que desea incluir en el diff resultado.
  <info>bool</info>    <strong>$minimal</strong>   Establezca este parámetro a <info>true</info> si desea reducir el tamaño del resultado
                     (puede tomar algo de tiempo).

<comment>Return:</comment>
  <info>string</info>  Devuelve un string con el resultado diff o <info>false</info> si ocurriera un error interno.

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


id: xdiff_string_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_string_bdiff
  
  Hace una diferencia binaria de dos cadenas y devuelve el resultado. Esta función trabaja con texto
  y datos binarios. El parche resultante puede ser posteriormente aplicado utilizando
  <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  Desde la versión 1.5.0 esta función es un alias de <strong>xdiff_string_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Primera cadena con información binaria. Esta actúa como "vieja" información.
  <info>string</info>  <strong>$new_data</strong>  Segunda cadena con información binaria. Esta actúa como "nueva" información.

<comment>Return:</comment>
  <info>string</info>  Devuelve cadena con resultado o <info>false</info> si se produce un error interno.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_merge3
type: function
doc:
<comment>Description:</comment>
  Unir tres cadenas en una
  
  Une tres cadenas en una y devuelve el resultado. El parámetro <strong>$old_data</strong> es una versión original de
  los datos mientras <strong>$new_data1</strong> y <strong>$new_data2</strong> son versiones modificadas de un original. El parámetro
  opcional <strong>$error</strong> es utilizado para admitir cualquier fragmento erróneo durante el proceso de unión.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>   Primera cadena con información. Esta actúa como "vieja" información.
  <info>string</info>  <strong>$new_data1</strong>  Segunda cadena con información. Esta actúa como versión modificada del
                      <strong>$old_data</strong>.
  <info>string</info>  <strong>$new_data2</strong>  La tercera cadena con información. Esta actúa como versión modificada del
                      <strong>$old_data</strong>.
  <info>string</info>  <strong>$error</strong>      Si se produce algún fragmento erróneo entonces se almacenan dentro de esta
                      variable.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve la cadena unida, <info>false</info> si se produce un error interno, o <info>true</info> si la cadena unida
         está vacía.

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


id: xdiff_string_patch
type: function
doc:
<comment>Description:</comment>
  Parchear una cadena con un diff unificado
  
  Parchea una cadena <strong>$str</strong> con un parche unificado en parámetro <strong>$patch</strong>  y devuelve el resultado.
  <strong>$patch</strong> tiene que ser un diff unificado creado por la función
  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong>.  Un parámetro opcional <strong>$flags</strong> especifica el modo de
  operación. Cualquier fragmento erróneo del parche será almacenado en el interior de la variable
  <strong>$error</strong> si  si esta es proporcionada.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La cadena original.
  <info>string</info>  <strong>$patch</strong>  La cadena parche unificada. Esta tiene que ser creada utilizando las funciones
                  <strong>xdiff_string_diff()</strong>,  <strong>xdiff_file_diff()</strong> o herramientas compatibles.
  <info>int</info>     <strong>$flags</strong>  <strong>$flags</strong> uede ser <info>XDIFF_PATCH_NORMAL</info> (modo por defecto, parche normal) o
                  <info>XDIFF_PATCH_REVERSE</info> (parche invertido).
                  
                  A partir de la versión 1.5.0, también se puede utilizar binario OR para habilitar
                  el indicador <info>XDIFF_PATCH_IGNORESPACE</info>.
  <info>string</info>  <strong>$error</strong>  Si se proporciona entonces los fragmentos erróneos se almacenan dentro de esta
                  variable.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena parcheada, o <info>false</info> en caso de error.

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


id: xdiff_string_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_string_bpatch
  
  Parchea una cadena <strong>$str</strong> con un <strong>$patch</strong> binario. Esta función acepta parches creados tanto a través
  de las funciones <strong>xdiff_string_bdiff()</strong> y <strong>xdiff_string_rabdiff()</strong> o de su archivo homólogo
  equivalente.
  
  Desde la versión 1.5.0 esta función es un alias de <strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La cadena binaria original.
  <info>string</info>  <strong>$patch</strong>  La cadena parche binaria.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena parcheada, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_rabdiff
type: function
doc:
<comment>Description:</comment>
  Hacer una diferencia binaria de dos cadenas utilizando el algoritmo polinomial de huella digital
  (fingerprinting) de Rabin
  
  Hace una diferencia binaria de dos cadenas y almacena el resultado. La diferencia entre esta
  función y <strong>xdiff_string_bdiff()</strong> es el diferente algoritmo que se utiliza que debería traducirse en
  una ejecución más rápida y un diff producido menor. Esta función trabaja con archivos de texto y
  binarios. El archivo parche resultante puede ser posteriormente aplicado utilizando
  <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  Para obtener más información sobre las diferencias entre el algoritmo utilizado por favor vea el
  sitio web libxdiff

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Primera cadena con información binaria. Esta actúa como "vieja" información.
  <info>string</info>  <strong>$new_data</strong>  Segunda cadena con información binaria. Esta actúa como "nueva" información.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena con la diferencia binaria conteniendo las diferencias entre "vieja" y
          "nueva" información o <info>false</info> si se ha producido un error interno.

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


id: xhprof_disable
type: function
doc:
<comment>Description:</comment>
  Detiene el perfilador xhprof
  
  Detiene el perfilador, y devuelve los datos xhprof de la ejecución.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> de los datos xhprof, de la ejecución.


id: xhprof_enable
type: function
doc:
<comment>Description:</comment>
  Inicia perfil xhprof
  
  Inicia perfiles xhprof.

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>    Flags opcionales para añadir información adicional a la creación de perfiles.
                   Véase las constantes XHprof Para obtener más información acerca de estos flags,
                   p. ej., <info>XHPROF_FLAGS_MEMORY</info> para permitir perfiles de memoria.
  <info>array</info>  <strong>$options</strong>  Un <info>array</info> de opciones opcionales, es decir, la opción 'ignored_functions' para
                   pasar en las funciones que se ignoraron durante el perfilado.

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

<comment>See Also:</comment>
   * <strong>xhprof_disable()</strong>
   * <strong>xhprof_sample_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xhprof_sample_disable
type: function
doc:
<comment>Description:</comment>
  Detiene la muestra del perfilador xhprof
  
  Detiene la muestra el modo perfilador xhprof, y

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> de los datos de muestra xhprof, de la ejecución.


id: xhprof_sample_enable
type: function
doc:
<comment>Description:</comment>
  Iniciar el analisis de XHProf en modo de muestreo
  
  Inicia la creación de perfiles en modo de muestra, que es una versión más ligera de peso de
  <strong>xhprof_enable()</strong> . El intervalo de muestreo es 0,1 segundos, y las muestras de registro de la pila
  de llamadas de función completa. El caso de uso principal es en gastos indirectos más bajos se
  requiere cuando se hace la supervisión del rendimiento y de diagnóstico.

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

<comment>See Also:</comment>
   * <strong>xhprof_sample_disable()</strong>
   * <strong>xhprof_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xml_error_string
type: function
doc:
<comment>Description:</comment>
  Obtiene la cadena de un error dado en un intérprete XML
  
  
  Obtiene la cadena asociada a un error <strong>$code</strong> dado en un intérprete XML.

<comment>Param:</comment>
  <info>int</info>  <strong>$code</strong>  Código de error como el obtenido desde <strong>xml_get_error_code()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string con una descripción textual del error <strong>$code</strong>, o <info>false</info> si no se ha
          encontrado una descripción asociada a ese código de error.

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


id: xml_get_current_byte_index
type: function
doc:
<comment>Description:</comment>
  Obtiene la indexación del byte actual en un intérprete XML
  
  Obtiene la indexación del byte actual en un intérprete XML dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Identificador del recurso del intérprete XML sobre el que se va a obtener la
                     indexación del byte actual.

<comment>Return:</comment>
  <info>int</info>  Devuelve cual es la indexación del byte en el que se haya actualmente el intérprete en el
       buffer de datos (empieza siendo 0), o devuelve <info>false</info> si <strong>$parser</strong> no se refiere a un intérprete
       válido.

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_column_number
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de columna actual para un intérprete XML
    
  
  Obtiene el número de columna actual para el intérprete XML dado.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Identificador del recurso del intérprete XML sobre el que se va a obtener el
                      número de columna.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de columna en la línea actual (como la dada de
       <strong>xml_get_current_line_number()</strong>) en la que se haya el intérprete en el buffer de datos, o
       devuelve <info>false</info> si <strong>$parser</strong> no se refiere a un intérprete válido.

<comment>See Also:</comment>
   * <strong>xml_get_current_byte_index()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_line_number
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de línea actual para un intérprete XML
  
  Obtiene el número de línea actual para el intérprete XML dado.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Identificador del recurso del intérprete XML sobre el que se va a obtener el
                      número de línea.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de línea en el que se haya el intérprete actualmente en el buffer de
       datos, o devuelve <info>false</info> si  <strong>$parser</strong> no se refiere a un intérprete válido.

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_byte_index()</strong>


id: xml_get_error_code
type: function
doc:
<comment>Description:</comment>
  Obtiene un código de error en un intérprete XML
  
  Obtiene un código de error dado en un intérprete XML.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Identificador del recurso del intérprete XML sobre el que se va a obtener el
                      valor de la opción.

<comment>Return:</comment>
  <info>int</info>  Esta función devuelve <info>false</info> si <strong>$parser</strong> no se refiere a un intérprete válido, si no devuelve
       un error de la lista: error codes section.

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


id: xml_parse
type: function
doc:
<comment>Description:</comment>
  Inicia un intérprete sobre un documento XML
  
  <strong>xml_parse()</strong> analiza un documento XML. Los manejadores para los eventos configurados son llamados
  tantas veces como sea necesario.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>    Identificador del recurso del intérprete XML que se va a usar.
  <info>string</info>    <strong>$data</strong>      Conjunto de información que se analizará. Un documento puede ser analizado
                       por trozos llamando varias veces con nuevos trozos a <strong>xml_parse()</strong>, siempre que
                       se establezca el parámetro <strong>$is_final</strong> y sea <info>true</info> cuando el último dato sea
                       analizado.
  <info>bool</info>      <strong>$is_final</strong>  Si existe y es <info>true</info>, <strong>$data</strong> es el último fragmento de datos enviados en este
                       intérprete.

<comment>Return:</comment>
  <info>int</info>  Devuelve 1 si el análisis se realiza con éxito o 0 en caso de error.
       
       Para análisis fallidos, se puede recuperar información del error con <strong>xml_get_error_code()</strong>,
       <strong>xml_error_string()</strong>, <strong>xml_get_current_line_number()</strong>, <strong>xml_get_current_column_number()</strong> and
       <strong>xml_get_current_byte_index()</strong>.
       
       Los errores de entidades son reportados al final de los datos, solo si <strong>$is_final</strong> existe y es
       <info>true</info>.


id: xml_parse_into_struct
type: function
doc:
<comment>Description:</comment>
  Interpreta datos XML en una estructura de array
  
  Esta función interpreta una cadena XML en dos estructuras paralelas de array, una (<strong>$index</strong>) que
  contiene punteros a la ubicación de los valores adecuados en el array <strong>$values</strong>. Estos dos últimos
  parámetros deben ser pasados por referencia.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Una referencia para el interprete de XML.
  <info>string</info>    <strong>$data</strong>    Una cadena que contiene los datos XML.
  <info>array</info>     <strong>$values</strong>  Un array que contiene los valores de los datos XML.
  <info>array</info>     <strong>$index</strong>   Un array que contiene apuntadores hacia la ubicación de los valores apropiados
                     en $values.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_parse_into_struct()</strong> retorna 0 cuando falla y 1 si es exitoso. Esto no es lo mismo que
       <info>false</info> y <info>true</info>, tener cuidado con operadores tales como ===.


id: xml_parser_create
type: function
doc:
<comment>Description:</comment>
  Crea un intérprete XML
  
  <strong>xml_parser_create()</strong> crea un nuevo intérprete XML y devuelve un identificador del recurso al que
  hace referencia, para ser usado por otras funciones XML.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  El parámetro opcional <strong>$encoding</strong> especifica la codificación de caracteres para
                     entrada y salida en PHP4. A partir de PHP5, la codificación de entrada se
                     detecta automaticamente, así que el parámetro <strong>$encoding</strong> especifica solo la
                     codificación de salida. En PHP 4, la codificación por defecto de salida es la
                     misma que la del juego de caracteres de la entrada. Si se le pasa una cadena
                     vacia, el intérprete intenta identificar cual es la codificación del documento
                     mirando los 3 o 4 primeros bytes. En PHP 5.0.0 y 5.0.1, el juego de caracteres
                     por defecto es ISO-8859-1, mientras que en PHP 5.0.2 y superior es UTF-8. Las
                     codificaciones soportadas son
                     <return>ISO-8859-1</return>, <return>UTF-8</return> y <return>US-ASCII</return>.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un identificador del recurso para el nuevo intérprete XML.

<comment>See Also:</comment>
   * <strong>xml_parser_create_ns()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_create_ns
type: function
doc:
<comment>Description:</comment>
  Crea un analizador XML con soporte para espacios de nombres
  
  <strong>xml_parser_create_ns()</strong> crea un nuevo analizador XML con soporte para espacios de nombres XML y
  devuelve un gestor de recurso que hace referencia al mismo, para poder utilizarlo con las demás
  funciones de XML.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>   El parámetro opcional <strong>$encoding</strong> especifica la codificación de caracteres para
                      la entrada y salida en PHP4. A partir de PHP5, la codificación de entrada es
                      detectada automáticamente, así que el parámetro <strong>$encoding</strong> especifica sólo la
                      codificación de salida. En PHP 4, la codificación de salida predeterminada es
                      la misma que la del juego de caracteres de la entrada. En PHP 5.0.0 y 5.0.1,
                      el juego de caracteres predeterminado es ISO-8859-1, mientras que en PHP 5.0.2
                      y posterior es UTF-8. Las codificaciones soportadas son <return>ISO-8859-1</return>, <return>UTF-8</return> y
                      <return>US-ASCII</return>.
  <info>string</info>  <strong>$separator</strong>  Con un analizador que tiene en cuenta los espacios de nombres, los parámetros
                      de etiquetas pasados a las diferentes funciones gestoras consistirán en el
                      espacio de nombres y el nombre de la etiqueta separado por el string
                      especificado en <strong>$separator</strong>.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un gestor de recurso para el nuevo analizador XML.

<comment>See Also:</comment>
   * <strong>xml_parser_create()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_free
type: function
doc:
<comment>Description:</comment>
  Liberar una analizador XML
  
  Liberar el <strong>$parser</strong> XML dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Una referencia a el analizador a liberar.

<comment>Return:</comment>
  <info>bool</info>  Ésta función devuelve <info>false</info> si <strong>$parser</strong> no refiere a un analizador valido, o sino lo libera
        al analizador y devuelve <info>true</info>.


id: xml_parser_get_option
type: function
doc:
<comment>Description:</comment>
  Obtiene el valor de las opciones de un intérprete XML
  
  Obtiene el valor de una opción de un intérprete XML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Identificador del recurso del intéprete XML sobre el que se va a obtener el
                     valor de la opción.
  <info>int</info>       <strong>$option</strong>  Indica cual es la opción para ir a buscar. Estan disponibles
                     <info>XML_OPTION_CASE_FOLDING</info> y <info>XML_OPTION_TARGET_ENCODING</info>. Para su descripción ver
                     <strong>xml_parser_set_option()</strong> .

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor de la opción. Puede devolver <info>false</info> si: <strong>$parser</strong> no se refiere a un
         intérprete válido o si <strong>$option</strong> no es válido, también generará un <info>E_WARNING</info> en ambos casos.


id: xml_parser_set_option
type: function
doc:
<comment>Description:</comment>
  Configura las opciones en un intérprete XML
  
  Configura una opción en un intérprete XML.

<comment>Param:</comment>
  <info>XMLParser</info>   <strong>$parser</strong>  Identificador del recurso del intérprete XML sobre el que se va a configurar
                       el valor de la opción.
  <info>int</info>         <strong>$option</strong>  Cual es la opción para configurar. Véase más abajo.
                       
                       Estan disponibles las siguientes opciones: Opciones del intérprete XMLOption
                       constantData typeDescription<info>XML_OPTION_CASE_FOLDING</info>integer
                       Controla si  case-folding está activada para este intérprete XML. Por defecto
                       activado.
                        <info>XML_OPTION_SKIP_TAGSTART</info>integer
                       Especifica el número de caracteres que seran omitidos al principio del nombre
                       de una etiqueta. <info>XML_OPTION_SKIP_WHITE</info>integer
                       Especifica si hay que omitir los valores que consistan en espacios en blanco.
                       <info>XML_OPTION_TARGET_ENCODING</info>string
                       Configura cual será el target encoding (codificación de caracteres de salida)
                       para usar en este intérprete XML. Por defecto se establece la misma
                       codificación de la fuente fuente usada por <strong>xml_parser_create()</strong>. Las
                       codificaciones de destino soportadas son <return>ISO-8859-1</return>, <return>US-ASCII</return> y <return>UTF-8</return>.
  <info>string|int</info>  <strong>$value</strong>   El nuevo valor para la opción.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si se ha establecido el nuevo valor para la opción. Puede devolver <info>false</info> si:
        <strong>$parser</strong> no se refiere a un intérprete válido, o si la opción no se ha podido configurar.


id: xml_set_character_data_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de los datos de caracteres
  
  Configura la función del manejador de los datos de caracteres para el intérprete XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Identificador del recurso del intérprete XML para el que se va a configurar
                       la función del manejador de datos de caracteres.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> es un string que contiene el nombre de una función que debe existir
                       cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                       
                       La función llamada mediante <strong>$handler</strong> debe aceptar dos parámetros:
                       handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> El primer parámetro, parser, hace
                       referencia al intérprete XML que llama al manejador. <strong>$data</strong> El segundo
                       parámetro, <strong>$data</strong>, contiene los datos de caracteres como un string.
                       
                       El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
                       
                       El segundo parámetro, <strong>$data</strong>, contiene los datos de caracteres como un string.
                       
                       El manejador de datos de caracteres es llamado para cada pieza de un texto en
                       el documento XML. Puede ser llamado multiples veces dentro de cada fragmento
                       (por ejemplo, para strings que no son ASCII).
                       
                       Si la función del manejador se configura como una cadena vacia, o <info>false</info>, el
                       manejador en cuestión se deshabilita.
                       
                       En lugar del nombre de una
                       función, se puede asignar un array que contenga la referencia a un objeto o
                       el nombre de un
                       método.
  <info>XMLParser</info>  <strong>$parser</strong>   El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
  <info>string</info>     <strong>$data</strong>     El segundo parámetro, <strong>$data</strong>, contiene los datos de caracteres como un string.

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


id: xml_set_default_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador predeterminado
  
  Configura la función del manejador predeterminado para el intérprete XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Identificador del recurso del intérprete XML para el que se va a configurar
                       la función del manejador predeterminado.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> es un string que contiene el nombre de una función que debe existir
                       cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                       
                       La función llamada mediante <strong>$handler</strong> debe aceptar dos parámetros:
                       handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> El primer parámetro, parser, hace
                       referencia al intérprete XML que llama al manejador. <strong>$data</strong> El segundo
                       parámetro, <strong>$data</strong>, contiene los datos de carateres. Esto puede ser la
                       declaración XML, las declaraciones DOCTYPE, entidades u otros datos para los
                       cuales no exista otro manejador.
                       
                       El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
                       
                       El segundo parámetro, <strong>$data</strong>, contiene los datos de carateres. Esto puede ser
                       la declaración XML, las declaraciones DOCTYPE, entidades u otros datos para
                       los cuales no exista otro manejador.
                       
                       Si la función del manejador se configura como una cadena vacia, o <info>false</info>, el
                       manejador en cuestión se deshabilita.
                       
                       En lugar del nombre de una
                       función, se puede asignar un array que contenga la referencia a un objeto o
                       el nombre de un
                       método.
  <info>XMLParser</info>  <strong>$parser</strong>   El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
  <info>string</info>     <strong>$data</strong>     El segundo parámetro, <strong>$data</strong>, contiene los datos de carateres. Esto puede ser
                       la declaración XML, las declaraciones DOCTYPE, entidades u otros datos para
                       los cuales no exista otro manejador.

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


id: xml_set_element_handler
type: function
doc:
<comment>Description:</comment>
  Configura los manejadores para los elementos de inicio y final
  
  Configura las funciones de los manejadores de elementos. <strong>$start_element_handler</strong> y
  <strong>$end_element_handler</strong> son strings que contienen los nombres de funciones que deben existir cuando
  <strong>xml_parse()</strong> sea llamado por <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>                 Identificador del recurso del intérprete XML para el que se van
                                    a configurar las funciones del manejador de elementos de inicio
                                    y final.
  <info>callable</info>  <strong>$start_element_handler</strong>  La función llamada mediante <strong>$start_element_handler</strong> debe aceptar
                                    tres parámetros:
                                    start_element_handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$name</strong><info>array</info><strong>$attribs</strong>
                                    <strong>$parser</strong> El primer parámetro, parser, hace referencia al
                                    intérprete XML que llama al manejador. <strong>$name</strong> El segundo
                                    parámetro, <strong>$name</strong>, contiene el nombre del elemento por el cual el
                                    manejador es llamado. Si case-folding está activado para este
                                    intérprete, el elemento name estará en letras mayúsculas.
                                    <strong>$attribs</strong> El tercer parámetro<strong>$attribs</strong>, contiene un array
                                    asociativo con los atributos del elemento (si hay alguno). Las
                                    claves de este array son los nombres de atributo, los valores
                                    son los valores de los atributos. Los nombres de los atributos
                                    están en mayúsculas case-folded siguiendo el mismo criterio que
                                    los nombres de los elementos. Los valores de los atributos no
                                    sufren las consecuencias de case-folding.  El orden original de
                                    los atributos puede ser recuperado recorriendo <strong>$attribs</strong> de
                                    manera normal, usando <strong>each()</strong>. La primera clave en el array es el
                                    primer atributo, y así sucesivamente.
                                    
                                    El primer parámetro, parser, hace referencia al intérprete XML
                                    que llama al manejador.
                                    
                                    El segundo parámetro, <strong>$name</strong>, contiene el nombre del elemento por
                                    el cual el manejador es llamado. Si case-folding está activado
                                    para este intérprete, el elemento name estará en letras
                                    mayúsculas.
                                    
                                    El tercer parámetro<strong>$attribs</strong>, contiene un array asociativo con
                                    los atributos del elemento (si hay alguno). Las claves de este
                                    array son los nombres de atributo, los valores son los valores
                                    de los atributos. Los nombres de los atributos están en
                                    mayúsculas case-folded siguiendo el mismo criterio que los
                                    nombres de los elementos. Los valores de los atributos no sufren
                                    las consecuencias de case-folding.
                                    
                                    El orden original de los atributos puede ser recuperado
                                    recorriendo <strong>$attribs</strong> de manera normal, usando <strong>each()</strong>. La primera
                                    clave en el array es el primer atributo, y así sucesivamente.
                                    
                                    En lugar del nombre de una
                                    función, se puede asignar un array que contenga la referencia a
                                    un objeto o el nombre de un
                                    método.
  <info>resource</info>  <strong>$parser</strong>                 El primer parámetro, parser, hace referencia al intérprete XML
                                    que llama al manejador.
  <info>string</info>    <strong>$name</strong>                   El segundo parámetro, <strong>$name</strong>, contiene el nombre del elemento por
                                    el cual el manejador es llamado. Si case-folding está activado
                                    para este intérprete, el elemento name estará en letras
                                    mayúsculas.
  <info>array</info>     <strong>$attribs</strong>                El tercer parámetro<strong>$attribs</strong>, contiene un array asociativo con
                                    los atributos del elemento (si hay alguno). Las claves de este
                                    array son los nombres de atributo, los valores son los valores
                                    de los atributos. Los nombres de los atributos están en
                                    mayúsculas case-folded siguiendo el mismo criterio que los
                                    nombres de los elementos. Los valores de los atributos no sufren
                                    las consecuencias de case-folding.
                                    
                                    El orden original de los atributos puede ser recuperado
                                    recorriendo <strong>$attribs</strong> de manera normal, usando <strong>each()</strong>. La primera
                                    clave en el array es el primer atributo, y así sucesivamente.
  <info>callable</info>  <strong>$end_element_handler</strong>    La función llamada mediante <strong>$end_element_handler</strong> debe aceptar
                                    dos parámetros: end_element_handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$name</strong>
                                    <strong>$parser</strong> El primer parámetro, parser, hace referencia al
                                    intérprete XML que llama al manejador. <strong>$name</strong> El segundo
                                    parámetro, <strong>$name</strong>, contiene el nombre del elemento por el cual el
                                    manejador es llamado. Si case-folding está activado para este
                                    intérprete, el elemento name estará en letras mayúsculas.
                                    
                                    El primer parámetro, parser, hace referencia al intérprete XML
                                    que llama al manejador.
                                    
                                    El segundo parámetro, <strong>$name</strong>, contiene el nombre del elemento por
                                    el cual el manejador es llamado. Si case-folding está activado
                                    para este intérprete, el elemento name estará en letras
                                    mayúsculas.
                                    
                                    Si la función del manejador se configura como una cadena vacia,
                                    o <info>false</info>, el manejador en cuestión se deshabilita.
  <info>resource</info>  <strong>$parser</strong>                 El primer parámetro, parser, hace referencia al intérprete XML
                                    que llama al manejador.
  <info>string</info>    <strong>$name</strong>                   El segundo parámetro, <strong>$name</strong>, contiene el nombre del elemento por
                                    el cual el manejador es llamado. Si case-folding está activado
                                    para este intérprete, el elemento name estará en letras
                                    mayúsculas.

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


id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de declaración de final del namespace
  
  Configura un manejador para ser llamado cuando se salga del alcance de una declaración de
  namespace. Se llamará por cada declaración de namespace, después del manejador de etiqueta final
  del elemento en el cual el namespace fue declarado.
  
  Este evento no es compatible con libXML, por lo que no se llamaría a un controlador registrado.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Identificador del recurso del intérprete XML.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> es una cadena que contiene el nombre de una función que debe existir
                       cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                       
                       La función llamada mediante <strong>$handler</strong> debe aceptar dos parámetros, y deberia
                       devolver un número entero. Si el valor devuelto desde el manejador es <info>false</info>
                       (lo cual ocurrirá si no se devulve un valor), el intérprete XML detendrá el
                       analizado y <strong>xml_get_error_code()</strong> devolverá
                       <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>. handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$prefix</strong>
                       <strong>$parser</strong> El primer parámetro, parser, es una referencia al intérprete XML que
                       llama al manejador. <strong>$prefix</strong> El prefijo es una cadena que se utiliza para
                       hacer referencia al namespace dentro de un objeto XML.
                       
                       El primer parámetro, parser, es una referencia al intérprete XML que llama al
                       manejador.
                       
                       El prefijo es una cadena que se utiliza para hacer referencia al namespace
                       dentro de un objeto XML.
                       
                       Si la función del manejador se configura como una cadena vacía, o <info>false</info>, el
                       manejador en cuestión es deshabilitado.
                       
                       En lugar del nombre de una
                       función, se puede asignar un array que contenga la referencia a un objeto o
                       el nombre de un
                       método.
  <info>XMLParser</info>  <strong>$parser</strong>   El primer parámetro, parser, es una referencia al intérprete XML que llama al
                       manejador.
  <info>string</info>     <strong>$prefix</strong>   El prefijo es una cadena que se utiliza para hacer referencia al namespace
                       dentro de un objeto XML.

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


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de referencia a entidades externas
  
  Configura la función del manejador de referencia a entidades externas para el intérprete XML
  <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>             Identificador del recurso del intérprete XML para el que se va a
                                configurar la función del manejador de referencia a entidades
                                externas
  <info>callable</info>  <strong>$handler</strong>            <strong>$handler</strong> es un string que contiene el nombre de una función que debe
                                existir cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                                
                                La función llamada mediante <strong>$handler</strong> debe aceptar cinco parámetros,
                                y deberia devolver un número entero. Si el valor devuelto desde el
                                manejador es <info>false</info> (lo cual ocurrirá si no se devulve un valor), el
                                intérprete XML detendrá el analizado y <strong>xml_get_error_code()</strong>
                                devolverá <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
                                handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><strong>$public_id</strong>
                                <strong>$parser</strong> El primer parámetro, parser, hace referencia al intérprete
                                XML que llama al manejador. <strong>$open_entity_names</strong> El segundo parámetro,
                                <strong>$open_entity_names</strong>, es una lista separada por espacios de los
                                nombres de las entidades que estan abiertas para el análisis de esta
                                entidad (incluyendo el nombre de la entidad referenciada). <strong>$base</strong>
                                Esta es la base para resolver el identificador de sistema
                                (<strong>$system_id</strong>) de la declaración de notación. Actualmente este
                                parámetro siempre se establecerá como una cadena vacia. <strong>$system_id</strong>
                                El cuarto parámetro, <strong>$system_id</strong>, es el identificador de sistema tal
                                como se especifica en la declaración de entidad. <strong>$public_id</strong> El
                                quinto parámetro, <strong>$public_id</strong>, es el identificador público  tal como
                                se especifica en la declaración de entidad, o una cadena vacia si no
                                se habia especificado; en el identificador público el espacio en
                                blanco se habrá normalizado como lo requerido mediante las
                                especificaciones XML.
                                
                                El primer parámetro, parser, hace referencia al intérprete XML que
                                llama al manejador.
                                
                                El segundo parámetro, <strong>$open_entity_names</strong>, es una lista separada por
                                espacios de los nombres de las entidades que estan abiertas para el
                                análisis de esta entidad (incluyendo el nombre de la entidad
                                referenciada).
                                
                                Esta es la base para resolver el identificador de sistema
                                (<strong>$system_id</strong>) de la declaración de notación. Actualmente este
                                parámetro siempre se establecerá como una cadena vacia.
                                
                                El cuarto parámetro, <strong>$system_id</strong>, es el identificador de sistema tal
                                como se especifica en la declaración de entidad.
                                
                                El quinto parámetro, <strong>$public_id</strong>, es el identificador público  tal
                                como se especifica en la declaración de entidad, o una cadena vacia
                                si no se habia especificado; en el identificador público el espacio
                                en blanco se habrá normalizado como lo requerido mediante las
                                especificaciones XML.
                                
                                Si la función del manejador se configura como una cadena vacia, o
                                <info>false</info>, el manejador en cuestión se deshabilita.
                                
                                En lugar del nombre de una
                                función, se puede asignar un array que contenga la referencia a un
                                objeto o el nombre de un
                                método.
  <info>resource</info>  <strong>$parser</strong>             El primer parámetro, parser, hace referencia al intérprete XML que
                                llama al manejador.
  <info>string</info>    <strong>$open_entity_names</strong>  El segundo parámetro, <strong>$open_entity_names</strong>, es una lista separada por
                                espacios de los nombres de las entidades que estan abiertas para el
                                análisis de esta entidad (incluyendo el nombre de la entidad
                                referenciada).
  <info>string</info>    <strong>$base</strong>               Esta es la base para resolver el identificador de sistema
                                (<strong>$system_id</strong>) de la declaración de notación. Actualmente este
                                parámetro siempre se establecerá como una cadena vacia.
  <info>string</info>    <strong>$system_id</strong>          El cuarto parámetro, <strong>$system_id</strong>, es el identificador de sistema tal
                                como se especifica en la declaración de entidad.
  <info>string</info>    <strong>$public_id</strong>          El quinto parámetro, <strong>$public_id</strong>, es el identificador público  tal
                                como se especifica en la declaración de entidad, o una cadena vacia
                                si no se habia especificado; en el identificador público el espacio
                                en blanco se habrá normalizado como lo requerido mediante las
                                especificaciones XML.

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


id: xml_set_notation_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de declaraciones de notación
  
  Configura la función del manejador de declaraciones de notación (NOTATION) para el intérprete XML
  <strong>$parser</strong>.
  
  Una declaración de notación es parte del DTD del documento y tiene el siguiente formato: $name</strong> {
  <strong>$systemId</strong> | <strong>$publicId</strong>?> ]]> Para la definición de declaraciones de notación ver sección 4.7 de las
  especificaciones XML 1.0 .

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>         Identificador del recurso del intérprete XML para el que se va a
                             configurar la función del manejador de declaración de notación.
  <info>callable</info>   <strong>$handler</strong>        <strong>$handler</strong> es un string que contiene el nombre de una función que debe
                             existir cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                             
                             La función llamada mediante <strong>$handler</strong> debe aceptar cinco parámetros:
                             handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$notation_name</strong><info>string</info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><strong>$public_id</strong>
                             <strong>$parser</strong> El primer parámetro, parser, hace referencia al intérprete XML
                             que llama al manejador. <strong>$notation_name</strong> Esto es el <strong>$name</strong> de la notación,
                             como se describió arriba en el formato de notación. <strong>$base</strong> Esta es la
                             base para resolver el identificador de sistema (<strong>$system_id</strong>) de la
                             declaración de notación. Actualmente este parámetro siempre se
                             establecerá como una cadena vacia. <strong>$system_id</strong> Identificador de sistema
                             de la declaración de notación externa. <strong>$public_id</strong> Identificador público
                             de la declaración de notación externa.
                             
                             El primer parámetro, parser, hace referencia al intérprete XML que
                             llama al manejador.
                             
                             Esto es el <strong>$name</strong> de la notación, como se describió arriba en el formato
                             de notación.
                             
                             Esta es la base para resolver el identificador de sistema (<strong>$system_id</strong>)
                             de la declaración de notación. Actualmente este parámetro siempre se
                             establecerá como una cadena vacia.
                             
                             Identificador de sistema de la declaración de notación externa.
                             
                             Identificador público de la declaración de notación externa.
                             
                             Si la función del manejador se configura como una cadena vacia, o
                             <info>false</info>, el manejador en cuestión se deshabilita.
                             
                             En lugar del nombre de una
                             función, se puede asignar un array que contenga la referencia a un
                             objeto o el nombre de un
                             método.
  <info>XMLParser</info>  <strong>$parser</strong>         El primer parámetro, parser, hace referencia al intérprete XML que
                             llama al manejador.
  <info>string</info>     <strong>$notation_name</strong>  Esto es el <strong>$name</strong> de la notación, como se describió arriba en el formato
                             de notación.
  <info>string</info>     <strong>$base</strong>           Esta es la base para resolver el identificador de sistema (<strong>$system_id</strong>)
                             de la declaración de notación. Actualmente este parámetro siempre se
                             establecerá como una cadena vacia.
  <info>string</info>     <strong>$system_id</strong>      Identificador de sistema de la declaración de notación externa.
  <info>string</info>     <strong>$public_id</strong>      Identificador público de la declaración de notación externa.

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


id: xml_set_object
type: function
doc:
<comment>Description:</comment>
  Usa un intérprete XML Parser dentro de un objeto
  
  Esta función permite usar <strong>$parser</strong> dentro de <strong>$object</strong>. Todas las funciones de retorno se podrian
  establecer con <strong>xml_set_element_handler()</strong>, etc y asumirlas como métodos de <strong>$object</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Identificador del recurso del intérprete XML para usar dentro del objeto.
  <info>object</info>     <strong>$object</strong>  El objeto donde usar el intérprete XML.

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


id: xml_set_processing_instruction_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de instrucciones de proceso (PI)
    
  
  Configura la función del manejador de instrucciones de proceso para el intérprete XML. <strong>$parser</strong>.
  
  Una instrucción de proceso tiene el siguiente formato: \<?target data??&gt;  Se puede poner código PHP dentro de esa etiqueta, pero ser consciente de una limitación: en un XML PI, la etiqueta de cierre PI tag (<return>?&gt;</return>) no puede ser entrecomillada, por lo que esta secuencia de caracteres no deberia aparecer en el código PHP embebido con PIs en documentos XML. Si esto sucede, el resto del código PHP, así como la etiqueta de cierre de PI "real", serán tratados como datos de caracteres.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Identificador del recurso del intérprete XML para el que se va a configurar
                       la función del manejador de instrucción de proceso.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> es un string que contiene el nombre de una función que debe existir
                       cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                       
                       La función llamada mediante <strong>$handler</strong> debe aceptar tres parámetros:
                       handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$target</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> El primer parámetro,
                       parser, hace referencia al intérprete XML que llama al manejador. <strong>$target</strong> El
                       segundo parámetro, <strong>$target</strong>, contiene el PI destino. <strong>$data</strong> El tercer
                       parámetro, <strong>$data</strong>, contiene los datos del PI
                       
                       El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
                       
                       El segundo parámetro, <strong>$target</strong>, contiene el PI destino.
                       
                       El tercer parámetro, <strong>$data</strong>, contiene los datos del PI
                       
                       Si la función del manejador se configura como una cadena vacia, o <info>false</info>, el
                       manejador en cuestión se deshabilita.
                       
                       En lugar del nombre de una
                       función, se puede asignar un array que contenga la referencia a un objeto o
                       el nombre de un
                       método.
  <info>XMLParser</info>  <strong>$parser</strong>   El primer parámetro, parser, hace referencia al intérprete XML que llama al
                       manejador.
  <info>string</info>     <strong>$target</strong>   El segundo parámetro, <strong>$target</strong>, contiene el PI destino.
  <info>string</info>     <strong>$data</strong>     El tercer parámetro, <strong>$data</strong>, contiene los datos del PI

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


id: xml_set_start_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de declaración de inicio del namespace
    
  
  Configura un manejador para ser llamado cuando un namespace es declarado. La declaración de
  namespace ocurre dentro de las etiquetas de inicio. Sin embargo, el manejador inicial de
  declaración del namespace es llamado antes del manejador de etiqueta inicial para cada namespace
  declarado en esa etiqueta de inicio.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Identificador del recurso del intérprete XML.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> es una cadena que contiene el nombre de una función que debe existir
                       cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                       
                       La función llamada mediante <strong>$handler</strong> debe aceptar tres parámetros, y deberia
                       devolver un número entero. Si el valor devuelto desde el manejador es <info>false</info>
                       (lo cual ocurrirá si no se devulve un valor), el intérprete XML detendrá el
                       analizado y <strong>xml_get_error_code()</strong> devolverá
                       <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
                       handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$prefix</strong><info>string</info><strong>$uri</strong> <strong>$parser</strong> El primer parámetro,
                       parser, es una referencia al intérprete XML que llama al manejador. <strong>$prefix</strong>
                       El prefijo es una cadena que se utiliza para hacer referencia al namespace
                       dentro de un objeto XML. <strong>$uri</strong> Identificador de Recurso Uniforme (URI, por sus
                       siglas en inglés) del namespace.
                       
                       El primer parámetro, parser, es una referencia al intérprete XML que llama al
                       manejador.
                       
                       El prefijo es una cadena que se utiliza para hacer referencia al namespace
                       dentro de un objeto XML.
                       
                       Identificador de Recurso Uniforme (URI, por sus siglas en inglés) del
                       namespace.
                       
                       Si una función del manejador se configura como una cadena vacía, o <info>false</info>, el
                       manejador en cuestión es deshabilitado.
                       
                       En lugar del nombre de una
                       función, se puede asignar un array que contenga la referencia a un objeto o
                       el nombre de un
                       método.
  <info>XMLParser</info>  <strong>$parser</strong>   El primer parámetro, parser, es una referencia al intérprete XML que llama al
                       manejador.
  <info>string</info>     <strong>$prefix</strong>   El prefijo es una cadena que se utiliza para hacer referencia al namespace
                       dentro de un objeto XML.
  <info>string</info>     <strong>$uri</strong>      Identificador de Recurso Uniforme (URI, por sus siglas en inglés) del
                       namespace.

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


id: xml_set_unparsed_entity_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configura el manejador de declaración de entidades no analizadas
  
  Configura la función del manejador de declaración de entidades no analizadas para el intérprete
  XML <strong>$parser</strong>.
  
  El <strong>$handler</strong> será llamado si el intérprete XML encuentra una declaración de entidad externa con una
  declaración NDATA, como la siguiente: $name</strong> {<strong>$publicId</strong> | <strong>$systemId</strong>} NDATA <strong>$notationName</strong>
  ]]>
  
  Para la definición de notación de NDATA ver sección 4.2.2 de las especificaciones XML 1.0.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>         Identificador del recurso del intérprete XML para el que se va a
                             configurar la función del manejador de declaración de entidades no
                             analizadas.
  <info>callable</info>   <strong>$handler</strong>        <strong>$handler</strong> es un string que contiene el nombre de una función que debe
                             existir cuando <strong>xml_parse()</strong> es llamado por <strong>$parser</strong>.
                             
                             La función llamada mediante <strong>$handler</strong> debe aceptar seis parámetros:
                             handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$entity_name</strong><info>string</info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><strong>$public_id</strong><info>string</info><strong>$notation_name</strong>
                             <strong>$parser</strong> El primer parámetro, parser, hace referencia al intérprete XML
                             que llama al manejador. <strong>$entity_name</strong> El nombre de la entidad que está a
                             punto de definirse. <strong>$base</strong> Esta es la base para resolver el
                             identificador de sistema (<strong>$system_id</strong>) de la declaración de notación.
                             Actualmente este parámetro siempre se establecerá como una cadena
                             vacia.
                              <strong>$system_id</strong> Identificador de sistema de la declaración de notación
                             externa. <strong>$public_id</strong> Identificador público de la declaración de notación
                             externa. <strong>$notation_name</strong> Nombre de la notación de esta entidad (ver
                             <strong>xml_set_notation_decl_handler()</strong>).
                             
                             El primer parámetro, parser, hace referencia al intérprete XML que
                             llama al manejador.
                             
                             El nombre de la entidad que está a punto de definirse.
                             
                             Esta es la base para resolver el identificador de sistema (<strong>$system_id</strong>)
                             de la declaración de notación. Actualmente este parámetro siempre se
                             establecerá como una cadena vacia.
                             
                             Identificador de sistema de la declaración de notación externa.
                             
                             Identificador público de la declaración de notación externa.
                             
                             Nombre de la notación de esta entidad (ver
                             <strong>xml_set_notation_decl_handler()</strong>).
                             
                             Si la función del manejador se configura como una cadena vacia, o
                             <info>false</info>, el manejador en cuestión se deshabilita.
                             
                             En lugar del nombre de una
                             función, se puede asignar un array que contenga la referencia a un
                             objeto o el nombre de un
                             método.
  <info>XMLParser</info>  <strong>$parser</strong>         El primer parámetro, parser, hace referencia al intérprete XML que
                             llama al manejador.
  <info>string</info>     <strong>$entity_name</strong>    El nombre de la entidad que está a punto de definirse.
  <info>string</info>     <strong>$base</strong>           Esta es la base para resolver el identificador de sistema (<strong>$system_id</strong>)
                             de la declaración de notación. Actualmente este parámetro siempre se
                             establecerá como una cadena vacia.
  <info>string</info>     <strong>$system_id</strong>      Identificador de sistema de la declaración de notación externa.
  <info>string</info>     <strong>$public_id</strong>      Identificador público de la declaración de notación externa.
  <info>string</info>     <strong>$notation_name</strong>  Nombre de la notación de esta entidad (ver
                             <strong>xml_set_notation_decl_handler()</strong>).

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


id: xmlrpc_decode
type: function
doc:
<comment>Description:</comment>
  Decodifica el XML en los tipos de PHP nativos
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>       La respuesta XML devuelta por el método XMLRPC.
  <info>string</info>  <strong>$encoding</strong>  Entrada de codificación que admite iconv.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve o un arreglo, o un entero, o una cadena, o un booleano conforme a la respuesta
         devuelta por el método XMLRPC.

<comment>See Also:</comment>
   * <strong>xmlrpc_encode_request()</strong>
   * <strong>xmlrpc_is_fault()</strong>


id: xmlrpc_decode_request
type: function
doc:
<comment>Description:</comment>
  Decodifica el XML en los tipos de PHP nativos
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_encode
type: function
doc:
<comment>Description:</comment>
  Genera XML para un valor PHP
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_encode_request
type: function
doc:
<comment>Description:</comment>
  Genera XML para el requerimiento de un método
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          El nombre del método a llamar.
  <info>mixed</info>   <strong>$params</strong>          Los parámetros de los métodos compatibles con la firma del método.
  <info>array</info>   <strong>$output_options</strong>  Las opciones de salida de un arreglo especifico  pueden contener (por
                           defecto valores que son enfatizados): output_type: php, xmlverbosity:
                           no_white_space, newlines_only, prettyescaping: cdata, non-ascii,
                           non-print, markup (may be a string with one value or an array with
                           multiple values)version: simple, xmlrpc, soap 1.1, autoencoding:
                           iso-8859-1, other character set supported by iconv
                           
                           output_type: php, xml
                           
                           verbosity: no_white_space, newlines_only, pretty
                           
                           escaping: cdata, non-ascii, non-print, markup (may be a string with one
                           value or an array with multiple values)
                           
                           version: simple, xmlrpc, soap 1.1, auto
                           
                           encoding: iso-8859-1, other character set supported by iconv

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena conteniendo la representación del XML del requerimiento.

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


id: xmlrpc_get_type
type: function
doc:
<comment>Description:</comment>
  Obtiene el tipo del xmlrpc para un valor PHP
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Ésta función es específicamente útil para la base64 y las cadenas fecha-hora.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  valor de PHP

<comment>Return:</comment>
  <info>string</info>  Devuelve el tipo de XML-RPC.

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


id: xmlrpc_is_fault
type: function
doc:
<comment>Description:</comment>
  Determina si el valor de un arreglo representa una falla del XMLRPC
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.

<comment>Param:</comment>
  <info>array</info>  <strong>$arg</strong>  El arreglo devuelto por <strong>xmlrpc_decode()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si emabargo si el argumento significa fallo retorna, <info>false</info>. La descripción de
        la falla o falta está disponible en <return>$arg["faultString"]</return>, fault el código está en
        <return>$arg["faultCode"]</return>.

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


id: xmlrpc_parse_method_descriptions
type: function
doc:
<comment>Description:</comment>
  Decodifica el XML en una lista de las descripciones del método
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_add_introspection_data
type: function
doc:
<comment>Description:</comment>
  Agrega una documentación introspectiva
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_call_method
type: function
doc:
<comment>Description:</comment>
  Analiza los requerimientos del XML y las llamadas de los métodos
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_create
type: function
doc:
<comment>Description:</comment>
  Crea un servidor xmlrpc
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_destroy
type: function
doc:
<comment>Description:</comment>
  Destruye los recursos del servidor
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_register_introspection_callback
type: function
doc:
<comment>Description:</comment>
  Registra una función PHP para generar la documentación
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_server_register_method
type: function
doc:
<comment>Description:</comment>
  Registra una función PHP para que el recurso del método coincida con method_name
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: xmlrpc_set_type
type: function
doc:
<comment>Description:</comment>
  Establece el tipo del xmlrpc, base64 o fecha-hora, para un valor de cadena PHP
  
  Establece el tipo del xmlrpc, base64 o fecha-hora, para un valor de cadena PHP.
  
  Esta función ha sido declarada
  EXPERIMENTAL. Su funcionamiento, nombre y
  la documentación que le acompaña puede cambiar sin previo aviso en futuras versiones de PHP.
  Utilícela bajo su propia responsabilidad.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Value to set the type
  <info>string</info>  <strong>$type</strong>   'base64' or 'datetime'

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. If successful, <strong>$value</strong> is converted
        to an object.


id: yaml_emit
type: function
doc:
<comment>Description:</comment>
  Devuelve la representación de un valor YAML
  
  Genera una representación YAML de los datos en <strong>$data</strong> proporcionados.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>       La <strong>$data</strong> se codifica. Puede ser de cualquier tipo excepto un <info>resource</info>.
  <info>int</info>    <strong>$encoding</strong>   Salida de codificación de caracteres elegidos desde <info>YAML_ANY_ENCODING</info>,
                     <info>YAML_UTF8_ENCODING</info>, <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>    <strong>$linebreak</strong>  Estilo de salida de línea de salto desde: <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                     <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>  <strong>$callbacks</strong>  Gestores de contenido para emitir nodos YAML. <info>array</info> asociativo de
                     referenciaciones de nombres de clase =&gt; <info>callable</info>. Véase emitir llamadas de
                     retorno para más detalles.

<comment>Return:</comment>
  <info>string</info>  Devuelve un <info>string</info> de YAML codificado si es correcto.

<comment>See Also:</comment>
   * <strong>yaml_emit_file()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_emit_file
type: function
doc:
<comment>Description:</comment>
  Enviar la representación YAML de un valor a un fichero
  
  Genera una representación YAML de <strong>$data</strong> proporcionada en el <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Ruta a el fichero.
  <info>mixed</info>   <strong>$data</strong>       La <strong>$data</strong> se codifica. Puede ser de cualquier tipo excepto un <info>resource</info>.
  <info>int</info>     <strong>$encoding</strong>   Salida de codificación de carácteres seleccionando entre <info>YAML_ANY_ENCODING</info>,
                      <info>YAML_UTF8_ENCODING</info>, <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>     <strong>$linebreak</strong>  Salida del estilo de salto de línea seleccionando entre <info>YAML_ANY_BREAK</info>,
                      <info>YAML_CR_BREAK</info>, <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>   <strong>$callbacks</strong>  Manejadores de contenido para emitir nodos YAML. <info>array</info> asociativo de nombre de
                      clase de asignaciones =&gt; <info>callable</info>. Véase emit callbacks para más detalles.

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

<comment>See Also:</comment>
   * <strong>yaml_emit()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_parse
type: function
doc:
<comment>Description:</comment>
  Analiza una secuencia de texto en formato YAML
  
  Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>      La secuencia de texto (<info>string</info>) a analizar en formato YAML.
  <info>int</info>     <strong>$pos</strong>        Documento YAML a extraer desde la secuencia de texto (<return>-1</return> para analizar todos
                      los documentos, <return>0</return> solo para el primer documento, etc).
  <info>int</info>     <strong>$ndocs</strong>      Si se facilita <strong>$ndocs</strong>, se completará con el número de documentos encontrados
                      en la secuencia de texto.
  <info>array</info>   <strong>$callbacks</strong>  Controlador de contenido para los nodos YAML. Es un <info>array</info> associativo de
                      etiquetas YAML =&gt; asociando sus <info>callback</info> correspondientes. Ver Analizar
                      callbacks para más información.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor codificado de <strong>$input</strong> en el formato apropiado de PHP o <info>false</info> en caso de
         error. Si el valor de <strong>$pos</strong> es <return>-1</return> devolverá un <info>array</info> con una entrada por cada documento
         encontrado en el texto.

<comment>See Also:</comment>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_file
type: function
doc:
<comment>Description:</comment>
  Analiza una secuencia de texto en formato YAML desde un fichero
  
  Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Ruta del nombre del fichero.
  <info>int</info>     <strong>$pos</strong>        Documento YAML a extraer desde la secuencia de texto (<return>-1</return> para analizar todos
                      los documentos, <return>0</return> solo para el primer documento, etc).
  <info>int</info>     <strong>$ndocs</strong>      Si se facilita <strong>$ndocs</strong>, se completará con el número de documentos encontrados
                      en la secuencia de texto.
  <info>array</info>   <strong>$callbacks</strong>  Controlador de contenido para los nodos YAML. Es un <info>array</info> associativo de
                      etiquetas YAML =&gt; asociando sus <info>callback</info> correspondientes. Ver  Analizar
                      callbacks para más información.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor codificado de <strong>$input</strong> en el formato apropiado de PHP o <info>false</info> en caso de
         error. Si el valor de <strong>$pos</strong> es <return>-1</return> devolverá un <info>array</info> con una entrada por cada documento
         encontrado en el texto.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_url
type: function
doc:
<comment>Description:</comment>
  Analiza una secuencia de texto Yaml desde una URL
  
  Convierte toda o parte de una secuencia de texto en YAML a una variable en PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        La dirección <strong>$url</strong> debe tener el formato "scheme://...". PHP buscará el
                      controlador de protocolos (también conocido como wrapper) para el esquema
                      especificado. Si no hay wrappers registrados para este protocolo, PHP lanzará
                      un aviso para ayudar a indentificar posibles problemas con el script y
                      continuar como si el nombre del fichero hiciera referencia a un fichero
                      normal.
  <info>int</info>     <strong>$pos</strong>        Documento YAML a extraer desde la secuencia de texto (<return>-1</return> para analizar todos
                      los documentos, <return>0</return> solo para el primer documento, etc).
  <info>int</info>     <strong>$ndocs</strong>      Si se facilita <strong>$ndocs</strong>, se completará con el número de documentos encontrados
                      en la secuencia de texto.
  <info>array</info>   <strong>$callbacks</strong>  Controlador de contenido para los nodos YAML. Es un <info>array</info> associativo de
                      etiquetas YAML =&gt; asociando sus <info>callback</info> correspondientes. Ver Analizar
                      callbacks para más información

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor codificado de <strong>$input</strong> en el formato apropiado de PHP o <info>false</info> en caso de
         error. Si el valor de <strong>$pos</strong> es <return>-1</return> devolverá un <info>array</info> con una entrada por cada documento
         encontrado en el texto.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_emit()</strong>


id: yaz_addinfo
type: function
doc:
<comment>Description:</comment>
  Devuelve un error adicional de información
  
  Devuelve un error adicional de información para el ultimo requerimiento al servidor.
  
  Con algunos servidores, Ésta función puede devolver la misma cadena como <strong>yaz_error()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El recurso de conexión devuelto por <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Una cadena contiene el error adicional de información o una cadena vacia si la ultima
          operación fue satisfactoria o si ninguna información fue proporcionada por el servidor.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_errno()</strong>


id: yaz_ccl_conf
type: function
doc:
<comment>Description:</comment>
  Configura el analizador CCL
  
  Ésta función configura la consulta analizadora CCL para un servidor con definiciones de puntos de
  acceso (Calificadores CCL) y su asignación al RPN.
  
  Para asignar una consulta especifica CCL al RPN después se llama la función <strong>yaz_ccl_parse()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$config</strong>  Un arreglo de configuración. Cada clave del arreglo es el nombre de un campo
                     CCL y el correspondiente valor que mantiene una cadena que especifica una
                     asignación al RPN.
                     
                     La asignación es una secuencia de el tipo de atributo, de los valores de los
                     atributos pares.  El tipo de atributo y el valor del atributo Attribute-type es
                     separado por un signo (<return>=</return>). Cada par es separado por un epacio en blanco.
                     
                     La información adicional la puede encontrar en la página CCL.

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

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


id: yaz_ccl_parse
type: function
doc:
<comment>Description:</comment>
  Inviocar el analizador Invoke CCL
  
  Esta función invoca un analizador CCL. Convierte una consulta dada CCL FIND a una consulta RPN la
  cual puede ser pasada también a la función <strong>yaz_search()</strong>  para ejecutar la búsqueda.
  
  Para definir un conjunto de campos validos CCL llaman preferiblemente a <strong>yaz_ccl_conf()</strong>  para
  definirlo en la función.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de la conexión retornado por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$query</strong>   La consulta CCL FIND.
  <info>array</info>     <strong>$result</strong>  Si la función fue ejecutada con éxito, Va a ser un arreglo conteniendo la
                     consulta RPN valida dentro de la clave <return>rpn</return>.
                     
                     En caso de fallo, tres índices son establecidos en este arreglo para indicar la
                     causa del fallo:  <return>errorcode</return> - El código de error CCL (entero) <return>errorstring</return> - El
                     error CCL de cadena <return>errorpos</return> - aproxima la posición en una consulta de fallo
                     (el entero es el carácter de posición)
                     
                     <return>errorcode</return> - El código de error CCL (entero)
                     
                     <return>errorstring</return> - El error CCL de cadena
                     
                     <return>errorpos</return> - aproxima la posición en una consulta de fallo (el entero es el
                     carácter de posición)

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


id: yaz_close
type: function
doc:
<comment>Description:</comment>
  Close YAZ connection
  
  Cierra la conexión dada por un parámetro <strong>$id</strong>.
  
  Esta función va solo a cerrar una conexión no persistente abierta por estableciendo la opción de
  <return>persistent</return> a <info>false</info> con <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El recurso de conexión retornado por <strong>yaz_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>yaz_connect()</strong>


id: yaz_connect
type: function
doc:
<comment>Description:</comment>
  Prepara una conexión a un servidor Z39.50
    
  
  Esta función devuelve un recurso de conexión en caso de éxito, cero en caso de fallo.
  
  <strong>yaz_connect()</strong> prepara una conexión a un servidor  Z39.50 .  Esta función es no bloqueante y no
  intenta establecer  una conexión - únicamente prepara la conexión para que pueda ser realizada
  posteriormente cuando  se llame a la función <strong>yaz_wait()</strong>.
  
  El proxy YAZ  es un proxy  Z39.50 disponible gratuitamente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zurl</strong>     Un string que toma la forma <return>host[:port][/database]</return>. Si se omite el port, se
                    utilizará el port 210. Si se omite database se utilizará <return>Default</return> .
  <info>mixed</info>   <strong>$options</strong>  Si se trata de un string, éste se trata como el string de autenticación Z39.50
                    V2   (OpenAuth).
                    
                    Si se trata de un array, el contenido del array sirve como opciones. user Nombre
                    de usuario para la autenticación. group Grupo para la autenticación. password
                    Contraseña para la autenticación. cookie Cookie para la sesión (proxy YAZ).
                    proxy Proxy para la conexión (proxy YAZ). persistent Un booleano. Si es <info>true</info> la
                    conexión es persistente; Si es <info>false</info> la conexión no es persistente. Por defecto
                    las conexiones son persistentes.  Si se abre una conexión persistente, no se
                    podrá cerrar posteriormente con la función <strong>yaz_close()</strong>. piggyback Un booleano.
                    Si es <info>true</info> piggyback está activado para las búsquedas; Si es <info>false</info> piggyback
                    está desactivado. Por defecto piggyback está activado.  Activar piggyback es más
                    eficiente y normalmente ahorra una ruta de ida y vuelta en la red para las
                    cargas de los registros por primera vez. Sin embargo, unos pocos servidores
                    Z39.50 no soportan piggyback o ignoran los nombres de los elementos
                    configurados. Para ellos, se debe desactivar piggyback. charset Un string que
                    especifica el mapa de caracteres que será utilizado como  lenguaje y mapa de
                    caracteres en la negociación Z39.50. Utilizar strings como: <return>ISO-8859-1</return>, <return>UTF-8</return>,
                    <return>UTF-16</return>.  Muchos servidores Z39.50 no soportan esta funcionalidad (y por ello,
                    ésta es  ignorada). Muchos servidores utilizan la codificación ISO-8859-1 para
                    consultas y mensajes. Los registros MARC21/USMARC no están afectados por este
                    parámetro preferredMessageSize Un entero que especifica el tamaño máximo de byte
                    para todos los registros que se devolverán por el objetivo durante la
                    recuperación. Ver el estandard Z39.50 para más información.  Esta opción está
                    soportada en PECL YAZ 1.0.5 o posteriores. maximumRecordSize Un entero que
                    especifica el tamaño máximo de byte de un único registro a ser devuelto por un
                    objetivo durante la recuperación. Esta entidad se denomina como un
                    Exceptional-record-size en el  standard Z39.50.  Esta opción está soportada en
                    PECL YAZ 1.0.5 o posteriores.
                    
                    Nombre de usuario para la autenticación.
                    
                    Grupo para la autenticación.
                    
                    Contraseña para la autenticación.
                    
                    Cookie para la sesión (proxy YAZ).
                    
                    Proxy para la conexión (proxy YAZ).
                    
                    Un booleano. Si es <info>true</info> la conexión es persistente; Si es <info>false</info> la conexión no
                    es persistente. Por defecto las conexiones son persistentes.
                    
                    Si se abre una conexión persistente, no se podrá cerrar posteriormente con la
                    función <strong>yaz_close()</strong>.
                    
                    Un booleano. Si es <info>true</info> piggyback está activado para las búsquedas; Si es <info>false</info>
                    piggyback está desactivado. Por defecto piggyback está activado.
                    
                    Activar piggyback es más eficiente y normalmente ahorra una ruta de ida y vuelta
                    en la red para las cargas de los registros por primera vez. Sin embargo, unos
                    pocos servidores Z39.50 no soportan piggyback o ignoran los nombres de los
                    elementos configurados. Para ellos, se debe desactivar piggyback.
                    
                    Un string que especifica el mapa de caracteres que será utilizado como  lenguaje
                    y mapa de caracteres en la negociación Z39.50. Utilizar strings como:
                    <return>ISO-8859-1</return>, <return>UTF-8</return>,  <return>UTF-16</return>.
                    
                    Muchos servidores Z39.50 no soportan esta funcionalidad (y por ello, ésta es
                    ignorada). Muchos servidores utilizan la codificación ISO-8859-1 para consultas
                    y mensajes. Los registros MARC21/USMARC no están afectados por este parámetro
                    
                    Un entero que especifica el tamaño máximo de byte para todos los registros que
                    se devolverán por el objetivo durante la recuperación. Ver el estandard Z39.50
                    para más información.
                    
                    Esta opción está soportada en PECL YAZ 1.0.5 o posteriores.
                    
                    Un entero que especifica el tamaño máximo de byte de un único registro a ser
                    devuelto por un objetivo durante la recuperación. Esta entidad se denomina como
                    un Exceptional-record-size en el  standard Z39.50.
                    
                    Esta opción está soportada en PECL YAZ 1.0.5 o posteriores.

<comment>Return:</comment>
  <info>mixed</info>  Un recurso de conexión en caso de éxito, <info>false</info> en caso de error.

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


id: yaz_database
type: function
doc:
<comment>Description:</comment>
  Especifica las bases de datos dentro de una sesión
    
  
  Esta función permite cambiar las bases de datos dentro de una sesión por una o más bases de datos
  especificadas a ser usadas en la búsqueda, recuperación, etc. - primordialmente a las bases de
  datos especificadas a ser llamadas <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$databases</strong>  Una cadena conteniendo una o más bases de datos. Múltiple bases de datos son
                        separadas por un signo de más<return>+</return>.

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


id: yaz_element
type: function
doc:
<comment>Description:</comment>
  Especifica el nombre del elemento establecido para recuperar
    
  
  Esta función especifica el nombre del elemento establecido para recuperar.
  
  Llama esta función antes de <strong>yaz_search()</strong> o <strong>yaz_present()</strong> para especificar el nombre del elemento
  establecido para los registros a ser recuperados.
  
  Si la función parece no tener efecto, ve la descripción de la opción <return>piggybacking</return> en
  <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>          El recurso de conexión retornado por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$elementset</strong>  Más servidores soportan <return>F</return> (para registros completos) y <return>B</return> (para registros
                         breves).

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


id: yaz_errno
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de error
  
  Devuelve un número de error del servidor (la última solicitud) identificado por  <strong>$id</strong>.
  
  <strong>yaz_errno()</strong> debe ser llamado después de la actividad de  red para cada servidor - (después del
  retorno de <strong>yaz_wait()</strong>) para determinar  el éxito o el fracaso de la última operación (p. e.j.
  search).

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El recurso de conexión devuelto por <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>int</info>  Devuelve un código de error. El código de error es un código de diagnóstico  Z39.50 (por lo
       general un diagnóstico de Bib-1) o el código de error del lado  del cliente que es generado
       por PHP/YAZ, como "Error de conexión", "Init rechazado", etc

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_error
type: function
doc:
<comment>Description:</comment>
  Devuelve la descripción del error
  
  <strong>yaz_error()</strong> retorna un mensaje textual en Inglés correspondiente al último error numérico como
  devuelto por <strong>yaz_errno()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El recurso de conexión retornado por <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve un mensaje textual por el servidor (último requerimiento), identificado por el
          parámetro <strong>$id</strong>. Una cadenma vacia es retornada si la última operación fue satisfactoria.

<comment>See Also:</comment>
   * <strong>yaz_errno()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_es
type: function
doc:
<comment>Description:</comment>
  Prepara para una solicitud de servicio extendido 
    
  
  Esta función prepara para una solicitud de servicio extendido. Los servicios extendidos es la
  familia de diversas facilidades Z39.50, tales como actualización de registros, ordenado de ítem,
  administración de base de datos, etc.
  
  Muchos servidores Z39.50 no soportan servicios extendidos.
  
  La <strong>yaz_es()</strong> crea un paquete de solicitud de servicio  extendido y la pone en una cola de
  operaciones. Se utiliza <strong>yaz_wait()</strong> para enviar la(s) solicitud(es) al servidor. Después de
  completar <strong>yaz_wait()</strong> el resultado de la operación del servicio extendido se debe esperar con una
  llamada a <strong>yaz_es_result()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>  Una string que representa el tipo de servicio extendido: <return>itemorder</return> (Ordenado de
                   ítem), <return>create</return> (Crear base de datos), <return>drop</return> (Descartar base de datos), <return>commit</return>
                   (Operación de cometer), <return>update</return> (Actualizar registro), <return>xmlupdate</return> (Actualizar XML).
                   Cada tipo se especifica en la sección siguiente.
  <info>array</info>     <strong>$args</strong>  Un array con las opciones de servicio extendido, más opciones específicas del
                   paquete. Las opciones son idénticas a las ofrecidas en la API C de ZOOM C.
                   Consulte a los servicios extendidos de ZOOM.

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

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


id: yaz_es_result
type: function
doc:
<comment>Description:</comment>
  Resulados de Servicios Extendidos de Inspección
    
  
  Esta función inspecciona el último resultado de servicio extendido  retornado de un servidor. Un
  servicio extendido es iniciado por cualquier <strong>yaz_item_order()</strong> o <strong>yaz_es()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El resultado de conexión retornado por <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un arreglo con <return>targetReference</return> elemento para la referencia en la operación del
         servicio extendido (generado y retornado del servidor).

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


id: yaz_get_option
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de opción para la conexión
  
  Devuelve el valor de la opción especificada con <strong>$name</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    El recurso de conexión retornado por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>  La opción del nombre.

<comment>Return:</comment>
  <info>string</info>  Devuelve el valor de la opción especificada o una cadena vacía si la opción wno está
          establecida.

<comment>See Also:</comment>
   * 
     La descripción de <strong>yaz_set_option()</strong> para las opciones
     disponibles
    


id: yaz_hits
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de éxitos de la última búsqueda
  
  <strong>yaz_hits()</strong>Devuelve el número de éxitos de la última  búsqueda.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>            El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$searchresult</strong>  Array de resultados para obtener información de resultados de búsqueda
                           detallada.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de éxitos de la última búsqueda o 0 si no se ha  realizado ninguna
       búsqueda.
       
       La matriz de resultados de búsqueda (si se suministra) contiene información  que es devuelta
       por un servidor Z39.50 en el formato SearchResult-1 parte de una respuesta de búsqueda. El
       formato SearchResult-1 puede utilizarse para obtener información acerca de  recuentos de
       éxitos para varias partes de la consulta (subconsulta). En particular, es posible obtener
       recuentos de éxitos para los términos de  búsqueda individuales en una consulta. Información
       para la primer subconsulta  está en $array[0], segunda subconsulta en $array[1], y así
       sucesivamente.
       
       El centro de SearchResult requiere PECL YAZ 1.0.5  o posterior y YAZ 2.1.9 o posterior.
       
       Muy pocas implementaciones Z39.50 soportan la instalación de SearchResult.


id: yaz_itemorder
type: function
doc:
<comment>Description:</comment>
  Prepara para la solicitud Z39.50 Item Order con el paquete ILL-Request
    
  
  Esta función prepara para una petición de tipo "Extended Services" utilizando el "Profile" para
  "Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1)". Ver aquí y la
  especificación.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$args</strong>  Debe ser un array asociativo con información sobre la solicitud  de los elementos
                   que serán enviados. La clave de la tabla hash es el nombre del camino de acceso
                   ASN.1 correspondiente. Por ejemplo, el ISBN bajo el Item-ID tiene la clave
                   item-id,ISBN.
                   
                   Los parámetros de la petición ILL son:
                   
                   También hay unos pocos parámetros que son parte del Paquete de Solicitud de
                   Servicios Extendidos y el paquete ItemOrder:

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


id: yaz_present
type: function
doc:
<comment>Description:</comment>
  Se prepara para la recuperación (Z39.50 presente)
    
  
  Esta función se prepara para la recuperación de archivos después de una búsqueda exitosa.
  
  La función <strong>yaz_range()</strong> debe ser llamado antes de esta función  para especificar el rango de
  registros a ser recuperados.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  El recurso de conexión devuelto por <strong>yaz_connect()</strong>.

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


id: yaz_range
type: function
doc:
<comment>Description:</comment>
  Específica un rango de registros a recuperar
    
  
  Específica un rango de registros a recuperar.
  
  Esta función debería ser llamada antes de <strong>yaz_search()</strong> o <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión retornado por <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$start</strong>   Especifíca la posición del primer registro a ser recuperado. Los  registros
                     numéricos van de 1 a <strong>yaz_hits()</strong>.
  <info>int</info>       <strong>$number</strong>  Específica un rango de registros a recuperar.

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


id: yaz_record
type: function
doc:
<comment>Description:</comment>
  Devuelve un registro
  
  La función <strong>yaz_record()</strong> inspecciona un registro del conjunto resultado actual que está en la
  posición especificada por el parámetro <strong>$pos</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$pos</strong>     La posición del registro. Las posiciones de los registros en el conjunto
                     resultado están numeradas con 1, 2, ... $hits donde $hits es el contador
                     devuelto por  <strong>yaz_hits()</strong>.
  <info>string</info>    <strong>$type</strong>    El parámetro <strong>$type</strong> especifica la forma del registro devuelto.
                     
                     Es la aplicación responsable de asegurar realmente que los registros son
                     devueltos en el formato correcto por el servidor Z39.50/SRW. El type indicado
                     únicamente especifica una conversión que se realizará en el lado cliente (en
                     PHP/YAZ).
                     
                     Además de la conversion del registro transferido a un string/array, PHP/YAZ
                     también puede realizar una conversión de mapa de caracteres del registro. Esto
                     es recomendado especialmente para USMARC/MARC21 puesto que éstos se devuelven
                     habitualmente en el mapa de caracteres MARC-8 que no está soportado por
                     navegadores, etc. Para especificar una conversión, añadir <return>; charset=</return>from<return>, </return>to
                     donde from es el mapa de caracteres original del registro y to es el mapa de
                     caracteres resultante (desde el punto de vista PHP).
                     
                     El registro se devuelve como un string de visualización simple. En este modo,
                     todos los registros MARC se convierten a un formato línea a línea ya que
                     ISO2709 es difícilmente legible. Los registros XML y SUTRS se devuelven en su
                     formato original. GRS-1 se devuelve en un (feo) formato línea a línea.
                     
                     Este formato es adecuado si los registros se mostrarán de forma rápida - para
                     depuración - o porque no es factible realizar una visualización adecuada.
                     
                     El registro se devuelve como un string XML si es posible. En este modo, todos
                     los registros MARC se convierten en MARCXML. Los registros XML y SUTRS se
                     devuelven en su formato original. GRS-1 no está soportado.
                     
                     Este formato es parecido a <strong>$string</strong> excepto por los registros MARC que se
                     convierten a MARCXML
                     
                     Este formato es adecuado si los registros se procesan posteriormente por un
                     interpretador XML o un procesador XSLT .
                     
                     El registro se devuelve como un string en su formato original. Este tipo es
                     adecuado para MARC, XML y SUTRS. No funciona con GRS-1.
                     
                     Los registros MARC se devuelven como un string ISO2709. XML y SUTRS son
                     devueltos como strings.
                     
                     La sintaxis del registro se devuelve como un string, p.e. <return>USmarc</return>, <return>GRS-1</return>, <return>XML</return>,
                     etc.
                     
                     El nombre de la base de datos asociada con el registro en la posición, se
                     devuelve como un string.
                     
                     El registro se devuelve como un array que refleja la estructura GRS-1. Este
                     tipo es adecuado para MARC y GRS-1. XML, SUTRS no están soportados y si el
                     registro actual es XML o SUTRS se devolverá un string vacío.
                     
                     El array devuelto consiste en una lista correspondiente a cada hoja/nodo
                     interno de GRS-1. Cada lista de elementos consiste en una sublista con el
                     primer elemento path y data (si los datos están disponibles).
                     
                     El camino de acceso, que es un string, contiene una lista de tres componentes
                     (del registro estructurado GRS-1) de la raíz a la hoja. Cada componente es un
                     par de tipo etiqueta/valor de etiqueta de la forma <return>(</return>type<return>,</return> value
                     
                     Las etiguqetas normalmente tienen un tipo tag 3. MARC también puede ser
                     devuelto como un array (se convierten a GRS-1 internamente).
  <info></info>          <strong>$string</strong>  El registro se devuelve como un string XML si es posible. En este modo, todos
                     los registros MARC se convierten en MARCXML. Los registros XML y SUTRS se
                     devuelven en su formato original. GRS-1 no está soportado.
                     
                     Este formato es parecido a <strong>$string</strong> excepto por los registros MARC que se
                     convierten a MARCXML
                     
                     Este formato es adecuado si los registros se procesan posteriormente por un
                     interpretador XML o un procesador XSLT .

<comment>Return:</comment>
  <info>string</info>  Devuelve el registro que se encuentra en la posición <strong>$pos</strong> o un string vacío si no existe
          ningún registro en la posición indicada.
          
          Si no hay registro en la posición indicada en la base de datos, se devolverá un string
          vacío.


id: yaz_scan
type: function
doc:
<comment>Description:</comment>
  Prepara para un escaneo YAZ
  
  Esta función prepara para una solicitud "Z39.50 Scan Request" en la conexión YAZ especificada.
  
  Para transferir realmente la "Scan Request" del servidor y recibir la  "Scan Response", debe
  llamarse <strong>yaz_wait()</strong>. Después de la finalización de la llamada a <strong>yaz_wait()</strong>, llamar a  <strong>yaz_error()</strong>
  y <strong>yaz_scan_result()</strong> para gestionar la respuesta.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>       Actualmente sólo está soportado el tipo <return>rpn</return> .
  <info>string</info>    <strong>$startterm</strong>  Punto de partida del escaneo.
                        
                        La forma en la que el punto de partida es especificado, viene dado por el
                        parámetro <strong>$type</strong>.
                        
                        La sintaxis de este parámetro es parecido al de la consulta RPN tal y como
                        se describe en <strong>yaz_search()</strong>. Consiste en cero o más especificaciones del
                        operador <return>@attr</return>, seguido de exactamente un token.
  <info>array</info>     <strong>$flags</strong>      Este parámetro opcional describe información adicional para controlar el
                        comportamiento de la solicitud de escaneo. Tres índices se leen actualmente
                        del array de marcas: <return>number</return> (número de términos solicitados), <return>position</return>
                        (posición preferida del término) y <return>stepSize</return> (tamaño preferido del paso).

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


id: yaz_scan_result
type: function
doc:
<comment>Description:</comment>
  Devuelve el resultado de un escaneado
  
  <strong>yaz_scan_result()</strong> devuelve una tabla con los términos y la información asociada tal y como fue
  recibida del servidor en la última función <strong>yaz_scan()</strong> realizada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión asociado por <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$result</strong>  Si se indica, este array será modificado para contener información adicional
                     tomada de la respuesta del scan: <return>number</return> - Número de entradas devueltas <return>stepsize</return>
                     - Tamaño del paso <return>position</return> - Posición del término <return>status</return> - Estado del escaneo
                     
                     <return>number</return> - Número de entradas devueltas
                     
                     <return>stepsize</return> - Tamaño del paso
                     
                     <return>position</return> - Posición del término
                     
                     <return>status</return> - Estado del escaneo

<comment>Return:</comment>
  <info>array</info>  Devuelve un array (0..n-1) donde n es el número de elementos devuetos. Cada valor es un par
         donde el primer elemento es el término, y el segundo es el contador de resultados.


id: yaz_schema
type: function
doc:
<comment>Description:</comment>
  Especifica el esquema para la recuperación
    
  
  <strong>yaz_schema()</strong> especifica el esquema para la recuperación.
  
  Esta función debe ser llamada antes de  <strong>yaz_search()</strong> o <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$schema</strong>  Debe ser especificado como un OID (identificador de objeto) notación de puntos
                     sin tratar (como <return> 1.2.840.10003.13.4 </return>) o  como uno de los esquemas conocidos
                     registrados: <return>GILS-schema</return>, <return>Holdings</return>, <return>Zthes</return>, ...

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


id: yaz_search
type: function
doc:
<comment>Description:</comment>
  Prepara una búsqueda
  
  <strong>yaz_search()</strong> prepara una búsqueda en la conexión   dada.
  
  Como <strong>yaz_connect()</strong> esta función es no bloqueante y únicamente prepara una búsqueda para ser
  ejecutada posteriormente cuando  se llame a la función <strong>yaz_wait()</strong> .

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>   Este parámetro representa el tipo de la consulta - únicamente <return>"rpn"</return> está
                    soportado ahora, en cuyo caso el tercer argumento especifica una consulta de
                    tipo   Type-1 en notación de prefijo de consulta.
  <info>string</info>    <strong>$query</strong>  La consulta RPN es una representación textual de la consulta Type-1 tal y como
                    está definida por el estandard Z39.50 . Sin embargo, en la representación del
                    texto utilizada por YAZ se necesita una notación de prefijo, es decir que el
                    operador precede a los operandos. El string de la consulta es una secuencia de
                    tokens donde se ignora el espacio en blanco a menos que esté rodeado de dobles
                    comillas. Los Tokens que empiecen  con una arroba (<return>@</return>) se considerarán
                    operadores, de otro modo, se tratarán como términos de búsqueda.
                    
                    Se muestra más información sobre atributos en el link  Z39.50 Maintenance Agency
                    site.
                    
                    Si se desea utilizar una notación más amigable,  utilizar el interpretador CCL -
                    functiones <strong>yaz_ccl_conf()</strong> y  <strong>yaz_ccl_parse()</strong>.

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


id: yaz_set_option
type: function
doc:
<comment>Description:</comment>
  Configura una o más opciones de la conexión
  
  Configura una o más opciones de la conexión dada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     El recurso de conexión devuelta por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>   Puede ser un string o un array.
                    
                    Si se informa un string, será el nombre de la opción a configurar. Será
                    necesario especificar su <strong>$value</strong>.
                    
                    Si se informa un array, será un array asociativo (nombre opción =&gt; valor
                    opción).
  <info>string</info>    <strong>$value</strong>  El nuevo valor de la opción. Utilizar este parámetro únicamente si el argumento
                    previo es un string.

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


id: yaz_sort
type: function
doc:
<comment>Description:</comment>
  Configura los criterios de búsqueda
  
  Esta función configura los criterios de búsqueda y activa la ordenación Z39.50 .
  
  LLamar a esta función antes de <strong>yaz_search()</strong>. Utilizar esta función por si sola no tiene ningún
  efecto. Cuando se usa en conjunción con <strong>yaz_search()</strong>, una ordenación Z39.50 se enviará después de
  que la  respuesta de la búsqueda ha sido recibida y antes de que cualquier registro sea recuperado
  con Z39.50 Present (<strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>        El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$criteria</strong>  Un string que toma la forma field1 flags1 field2  flags2 donde field1
                       especifica los atributos primarios para ordenar, field2 los secundarios,
                       etc..
                       
                       El campo especifica ya sea combinaciones de atributos numéricos consistentes
                       de pares type=value separados por una coma (p.e. <return>1=4,2=1</return>) ; o el campo debe
                       especificar un string con el criterio (p.e.  <return>título</return>). Los flags son
                       secuencias de los caracteres  siguientes que no pueden estar separados por
                       ningún espacio.
                       
                       Sort Flags<return>a</return> Ordenar de forma ascendente <return>d</return> Ordenar de forma descendente <return>i</return> No
                       diferenciar entre mayúsculas o minúsculas en la ordenación <return>s</return> Diferenciar
                       entre mayúsculas o minúsculas en la ordenación
                       
                       Ordenar de forma ascendente
                       
                       Ordenar de forma descendente
                       
                       No diferenciar entre mayúsculas o minúsculas en la ordenación
                       
                       Diferenciar entre mayúsculas o minúsculas en la ordenación

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


id: yaz_syntax
type: function
doc:
<comment>Description:</comment>
  Especifica la sintaxis de registro preferida para la recuperación
    
  
  <strong>yaz_syntax()</strong> especifica la sintaxis de registro preferida para  la recuperación
  
  Esta función debe ser llamada antes de <strong>yaz_search()</strong> o  <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      El recurso de conexión devuelto por <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$syntax</strong>  La sintaxis debe especificarse como un OID (identificador de objeto) en una
                     notación de puntos sin tratar (como <return>1.2.840.10003.5.10</return>) o como una  de las
                     sintaxis conocidas (sutrs, usmarc, grs1, xml, etc.).

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


id: yaz_wait
type: function
doc:
<comment>Description:</comment>
  Espera que las peticiones Z39.50 se completeten
  
  Esta función lleva a cabo en red (bloqueada) la actividad para la  solicitudes pendientes que han
  sido preparados por las funciones  <strong>yaz_connect()</strong>, <strong>yaz_search()</strong>,  <strong>yaz_present()</strong>, <strong>yaz_scan()</strong> y
  <strong>yaz_itemorder()</strong>.
  
  <strong>yaz_wait()</strong> devuelve cuando todos los servidores han  completado todas las solicitudes o abortado
  (en caso de error).

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Un array asociativo de opciones: <return>timeout</return> Establece el tiempo de espera en
                   segundos. Si un servidor no ha respondido en el  tiempo de espera se considera
                   muerto y retorna <strong>yaz_wait()</strong>.  El valor por omisión de tiempo de espera es de 15
                   segundos. <return>event</return> Un boolean.
                   
                   Establece el tiempo de espera en segundos. Si un servidor no ha respondido en el
                   tiempo de espera se considera muerto y retorna <strong>yaz_wait()</strong>.  El valor por omisión
                   de tiempo de espera es de 15 segundos.
                   
                   Un boolean.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. En modo event, retorna un recource
         o <info>false</info> en caso de error.


id: zend_thread_id
type: function
doc:
<comment>Description:</comment>
  Devuelve un identificador único del thread actual
  
  Esta función devuelve un identificador único del thread actual.

<comment>Return:</comment>
  <info>int</info>  Devuelve thread id en formato integer.


id: zend_version
type: function
doc:
<comment>Description:</comment>
  Obtiene la versión del motor Zend actual
  
  Devuelve una cadena que contiene la versión del Motor Zend ejecutándose actualmente.

<comment>Return:</comment>
  <info>string</info>  Devuelve el número de versión del Motor Zend, como una cadena.

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>php_logo_guid()</strong>
   * <strong>phpversion()</strong>


id: zip_close
type: function
doc:
<comment>Description:</comment>
  Cierra un fichero ZIP
  
  Cierra el archivo ZIP archivo dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Un fichero ZIP previamente abierto con <strong>zip_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_close
type: function
doc:
<comment>Description:</comment>
  Cierra la entrada a un directorio
  
  Cierra la entrada del directorio especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada del directorio previamente abierto con <strong>zip_entry_open()</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>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_compressedsize
type: function
doc:
<comment>Description:</comment>
  Obtiene el tamaño comprimido de una entrada de directorio
  
  Devuelve el tamaño comprimido de una especifica entrada de directorio.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada de directorio devuelva por <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>int</info>  El tamaño comprimido.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_compressionmethod
type: function
doc:
<comment>Description:</comment>
  Devuelve el método de compresión de una entrada de directorio
  
  Devuelve el método de compresión de una entrada de directorio especificada por <strong>$zip_entry</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada de directorio devuelta por <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>string</info>  El método de compresión.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_filesize
type: function
doc:
<comment>Description:</comment>
  Devuelve el tamaño del fichero actual de una entrada de directorio
  
  Devuelve el tamaño actual de una entrada de directorio específica.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada de directorio devuelva por <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>int</info>  El tamaño de una entrada de directorio.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_name
type: function
doc:
<comment>Description:</comment>
  Devuelve el nombre de la entrada de un directorio
  
  Devuelve el nombre de una entrada de directorio específica.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada de directorio devuelta por <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>string</info>  El nombre de la entrada de directorio.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_open
type: function
doc:
<comment>Description:</comment>
  Abrir una entrada de directorio para lectura
  
  Abre una entrada de directorio en un fichero zip para lectura.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>        Un válido controlador de recurso es devuelto por <strong>zip_open()</strong>.
  <info>resource</info>  <strong>$zip_entry</strong>  Una entrada de directorio es devuelta por <strong>zip_read()</strong>.
  <info>string</info>    <strong>$mode</strong>       Cualquiera de los modos especificados en la documentación de <strong>fopen()</strong>.
                        
                        Actualmente, el <strong>$mode</strong> es ignorado y es siempre <return>"rb"</return>. Esto es debido al hecho
                        que el soporte zip en  PHP es solamente de acceso lectura.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.
        
        A diferencia de <strong>fopen()</strong> y otras funciones similares, el valor devuelto por <strong>zip_entry_open()</strong>
        solo indica el resultado de la operación y no es necesario para la lectura o cerrado de la
        entrada de directorio.

<comment>See Also:</comment>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_read
type: function
doc:
<comment>Description:</comment>
  Leer desde una entrada de directorio abierta
  
  Lee desde una entrada de directorio abierta.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un directorio devuelto por <strong>zip_read()</strong>.
  <info>int</info>       <strong>$length</strong>     El número de bytes a devolver.
                        
                        Esto debería ser el tramo descomprimido que se desea leer.

<comment>Return:</comment>
  <info>string</info>  Devuelve los datos leídos, un string vacío si se encuentra al final de un fichero, o <info>false</info>
          en case de error.

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_filesize()</strong>


id: zip_open
type: function
doc:
<comment>Description:</comment>
  Abre un fichero ZIP
  
  Abre un nuevo fichero ZIP para su lectura.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El nombre del fichero ZIP a abrir.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un manejador del recurso para usarlo después con <strong>zip_read()</strong> y <strong>zip_close()</strong> o
            devolver el número de error si <strong>$filename</strong> no existe o en caso de otro error.

<comment>See Also:</comment>
   * <strong>zip_read()</strong>
   * <strong>zip_close()</strong>


id: zip_read
type: function
doc:
<comment>Description:</comment>
  Leer la siguiente entrada en el fichero ZIP
  
  Lee la siguiente entrada en un fichero zip.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Un fichero ZIP previamente abierto con <strong>zip_open()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Devuelve un recurso de una entrada de directorio para poder usar luego las funciones
            <return>zip_entry_...</return>, o <info>false</info> si no hay más entradas a leer, o código de error en caso de
            ocurrir otro error.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_close()</strong>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zlib_decode
type: function
doc:
<comment>Description:</comment>
  Descomprime datos codificados en craw/gzip/zlib
  
  Descomprime datos codificados en raw/gzip/zlib.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$max_length</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Devuelve los datos no comprimidos,  o <info>false</info> en caso de error.

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


id: zlib_encode
type: function
doc:
<comment>Description:</comment>
  Comprime datos con la codificación especificada
  
  Comprime datos con la codificación especificada.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Los datos a comprimir.
  <info>int</info>     <strong>$encoding</strong>  El algoritmo de compresión. O bien <info>ZLIB_ENCODING_RAW</info>, <info>ZLIB_ENCODING_DEFLATE</info> o
                     <info>ZLIB_ENCODING_GZIP</info>.
  <info>int</info>     <strong>$level</strong>     

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

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


id: zlib_get_coding_type
type: function
doc:
<comment>Description:</comment>
  Retorna el tipo de codificación utilizada para hacer la compresión
  
  Retorna el tipo de codificación utilizada para hacer la compresión.

<comment>Return:</comment>
  <info>string|false</info>  Los posibles valores de retorno son <return>gzip</return>, <return>deflate</return> o <info>false</info>.

<comment>See Also:</comment>
   * 
     La directiva zlib.output_compression
    


id: zookeeper_dispatch
type: function
doc:
<comment>Description:</comment>
  Calls callbacks for pending operations
  
  The <strong>zookeeper_dispatch()</strong> function calls the callbacks passed by operations like Zookeeper::get or
  Zookeeper::exists.
  
  Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If
  you want that to be done automatically, you also can declare ticks at the beginning of your
  program.
  
  After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement
  async dispatch.

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

<comment>See Also:</comment>
   * Zookeeper::addAuth
   * Zookeeper::connect
   * Zookeeper::__construct
   * Zookeeper::exists
   * Zookeeper::get
   * Zookeeper::getChildren
   * Zookeeper::setWatcher


