mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
141 lines
4.4 KiB
XML
141 lines
4.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: f9c4a68ef4f89e51e6d9b905ad3ddb6492386dd3 Maintainer: takagi Status: ready -->
|
|
<!-- CREDITS: hirokawa,shimooka,mumumu -->
|
|
<refentry xml:id="function.gzencode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>gzencode</refname>
|
|
<refpurpose>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>
|
|
この関数は、入力 <parameter>data</parameter>を
|
|
<command>gzip</command> プログラムの出力と互換性のある形式で圧縮
|
|
して返します。
|
|
</para>
|
|
<para>
|
|
GZIPファイルフォーマットに関する詳細な情報については、次のドキュ
|
|
メントを参照ください。
|
|
<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>
|
|
エンコードするデータを指定します
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>level</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
圧縮レベルを指定します。
|
|
圧縮をしない場合に 0、最大限の圧縮を行う場合に9を指定可能です。
|
|
指定されない場合のデフォルト圧縮レベルは、
|
|
zlib ライブラリのデフォルト圧縮レベルになります。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
エンコーディングモードを指定します。
|
|
<constant>FORCE_GZIP</constant> (デフォルト) もしくは
|
|
<constant>FORCE_DEFLATE</constant> を指定可能です。
|
|
</para>
|
|
<para>
|
|
<constant>FORCE_DEFLATE</constant> は
|
|
RFC 1950 準拠の出力を生成します。
|
|
これは、zlib ヘッダ、圧縮したデータ、
|
|
そして Adler チェックサムで構成されます。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
エンコードされた文字列、もしくはエラー発生時に &false;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
結果データは標準的な .gz
|
|
ファイルを構成するための適当なヘッダとデータ構造を含みます。
|
|
<example>
|
|
<title>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">
|
|
ZLIB Compressed Data Format Specification (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
|
|
-->
|