exif-thumbnail.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cbac1ecf71d754707d69bdc344c4031c157eaa54 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.exif-thumbnail" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>exif_thumbnail</refname>
  <refpurpose>画像に埋め込まれたサムネイルを取得する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>exif_thumbnail</methodname>
   <methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>file</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">width</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">height</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">image_type</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>exif_thumbnail</function> は、
   画像に埋め込まれたサムネイルを読み込みます。
  </para>
  <para>
   この関数を使用してサムネイルを出力したい場合は、
   <function>header</function> 関数を使用して mimetype 情報を送信する
   必要があります。
  </para>
  <para>
   <function>exif_thumbnail</function> が画像を作成することはできないが、
   そのサイズだけはわかるという可能性があります。そのような場合、戻り値は
   &false; となりますが <parameter>width</parameter> および
   <parameter>height</parameter> を設定されています。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>file</parameter></term>
     <listitem>
      <para>
       読み込む画像ファイルの名前。サムネイルが埋め込まれています。
       画像ファイルの位置。これはファイルのパスか、ストリーム <type>resource</type> です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       返されるサムネイルの幅が格納されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       返されるサムネイルの高さが格納されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>image_type</parameter></term>
     <listitem>
      <para>
       返されるサムネイルの画像タイプが格納されます。
       <acronym>TIFF</acronym> あるいは <acronym>JPEG</acronym>
       のどちらかです。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   埋め込まれたサムネイルを返します。画像がサムネイルを含まない場合は
   &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <parameter>file</parameter> パラメータは
        ローカルファイルとストリームリソースを両方サポートするようになりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>exif_thumbnail</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$image = exif_thumbnail('/path/to/image.jpg', $width, $height, $type);
if ($image!==false) {
    header('Content-type: ' .image_type_to_mime_type($type));
    echo $image;
    exit;
} else {
    // no thumbnail available, handle the error here
    echo 'No thumbnail available';
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数にストリームを渡すために <parameter>file</parameter> を使った場合、
    ストリームはシーク可能でなければなりません。
    ファイルポインタの位置は、関数から戻った後でも変化しないことに注意してください。
   </para>
  </note>
 </refsect1> 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>exif_read_data</function></member>
    <member><function>image_type_to_mime_type</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
-->