gzcompress.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 976425d4f6eec32448be3cc22ec063015921b753 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.gzcompress" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>gzcompress</refname>
  <refpurpose>Comprime una cadena</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>gzcompress</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>level</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>ZLIB_ENCODING_DEFLATE</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Esta función comprime la cadena dada usando el formato de datos
   <literal>ZLIB</literal>.
  </para>
  <para>
   Para detalles sobre el algoritmo de compresión ZLIB, ver el
   documento "<link xlink:href="&url.rfc;1950">ZLIB Compressed Data Format
   Specification version 3.3</link>" (RFC 1950).
  </para>
  <note>
   <para>
    Esto <emphasis>no</emphasis> es lo mismo que la compresión que gzip,
    la cuál incluye algunos encabezados de datos. Ver <function>gzencode</function>
    para la compresión gzip.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Los datos a comprimir.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>level</parameter></term>
     <listitem>
      <para>
       El nivel de compresión. Se puede dar como 0 para ninguna compresión,
       hasta 9 para la máxima compresión.
      </para>
      <para>
       Si se utiliza -1, se usará la compresión por defecto de la librería zlib la cual es 6.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       Una de las constentes <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La cadena comprimida o &false; si ocurre un error.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>gzcompress</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$compressed = gzcompress('Compress me', 9);
echo $compressed;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gzdeflate</function></member>
    <member><function>gzinflate</function></member>
    <member><function>gzuncompress</function></member>
    <member><function>gzencode</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->