mirror of
https://github.com/php/doc-es.git
synced 2026-03-24 07:22:16 +01:00
136 lines
4.0 KiB
XML
136 lines
4.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: f9c4a68ef4f89e51e6d9b905ad3ddb6492386dd3 Maintainer: jpberdejo Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<refentry xml:id="function.gzencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>gzencode</refname>
|
|
<refpurpose>Crea una cadena comprimida con gzip</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>gzencode</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_GZIP</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Esta función retorna una versión comprimida de la <parameter>data</parameter>
|
|
de entrada, compatible con la salida del programa <command>gzip</command>.
|
|
</para>
|
|
<para>
|
|
Para más información sobre el formato de archivo GZIP, ver el
|
|
documento: <link xlink:href="&url.rfc;1952">GZIP file format specification
|
|
version 4.3</link> (RFC 1952).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Los datos a codificar.
|
|
</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. Si no se incluye, se utilizará
|
|
el nivel de compresión por defecto de la librería zlib.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
El modo de codificación. Puede ser <constant>FORCE_GZIP</constant>
|
|
(por defecto) o <constant>FORCE_DEFLATE</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>FORCE_DEFLATE</constant> genera
|
|
una salida que cumple el RFC 1950, consistente en un encabezado zlib, los datos
|
|
comprimidos y una suma de control Adler.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
La cadena codificada o &false; si ocurre un error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
Los datos resultantes contienen los encabezados y estructura
|
|
de datos apropiados para construir un archivo .gz estándar,
|
|
por ejemplo:
|
|
<example>
|
|
<title>Creando un archivo gzip</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$data = file_get_contents("bigfile.txt");
|
|
$gzdata = gzencode($data, 9);
|
|
file_put_contents("bigfile.txt.gz", $gzdata);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>gzdecode</function></member>
|
|
<member><function>gzdeflate</function></member>
|
|
<member><function>gzinflate</function></member>
|
|
<member><function>gzuncompress</function></member>
|
|
<member><function>gzcompress</function></member>
|
|
<member>
|
|
<link xlink:href="&url.rfc;1950">
|
|
Especificación del formato ZLIB de compresión de datos (RFC 1950)
|
|
</link>
|
|
</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
|
|
-->
|