smarty/docs/ja/designers/language-custom-functions/language-function-html-image.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2602 Maintainer: takagi Status: ready -->
<!-- CREDITS: mat-sh,daichi,joe -->
<sect1 id="language.function.html.image">
 <title>{html_image}</title>
  <para>
   <varname>{html_image}</varname> は、HTML の <literal>&lt;img&gt;</literal>
   タグを作成する
   <link linkend="language.custom.functions">カスタム関数</link> です。
   <parameter>height</parameter> 属性と <parameter>width</parameter>
   属性を省略した場合は、画像ファイルから自動的に算出します。
 </para>

 <informaltable frame="all">
  <tgroup cols="5">
   <colspec colname="param" align="center" />
   <colspec colname="type" align="center" />
   <colspec colname="required" align="center" />
   <colspec colname="default" align="center" />
   <colspec colname="desc" />
   <thead>
    <row>
     <entry>属性名</entry>
     <entry>型</entry>
     <entry>必須</entry>
     <entry>デフォルト</entry>
     <entry>概要</entry>
    </row>
   </thead>
   <tbody>
    <row>
     <entry>file</entry>
     <entry>string</entry>
     <entry>Yes</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>画像のパス・ファイル名</entry>
    </row>
    <row>
     <entry>height</entry>
     <entry>string</entry>
     <entry>No</entry>
     <entry><emphasis>実際の画像の高さ</emphasis></entry>
     <entry>画像を表示する高さ</entry>
    </row>
    <row>
     <entry>width</entry>
     <entry>string</entry>
     <entry>No</entry>
     <entry><emphasis>実際の画像の幅</emphasis></entry>
     <entry>画像を表示する幅</entry>
    </row>
    <row>
     <entry>basedir</entry>
     <entry>string</entry>
     <entry>no</entry>
     <entry><emphasis>web サーバのドキュメントルート</emphasis></entry>
     <entry>相対パスの基準となるディレクトリ</entry>
    </row>
    <row>
     <entry>alt</entry>
     <entry>string</entry>
     <entry>no</entry>
     <entry><emphasis><quote></quote></emphasis></entry>
     <entry>画像の代替テキスト</entry>
    </row>
    <row>
     <entry>href</entry>
     <entry>string</entry>
     <entry>no</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>画像にリンクする href の値</entry>
    </row>
    <row>
     <entry>path_prefix</entry>
     <entry>string</entry>
     <entry>no</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>出力パスのプレフィックス</entry>
    </row>
   </tbody>
  </tgroup>
 </informaltable>

<itemizedlist>
<listitem><para>
  <parameter>basedir</parameter> 属性は、画像の相対パスの基準となるベースディレクトリです。
  指定しなかった場合は、web サーバのドキュメントルートである
  <varname>$_ENV['DOCUMENT_ROOT']</varname> を使用します。
  <link linkend="variable.security"><parameter>$security</parameter></link>
  が有効な場合は、画像のパスは
  <link linkend="variable.secure.dir">セキュアディレクトリ</link>
  内になければなりません。
 </para></listitem>

 <listitem><para>
  <parameter>href</parameter> は画像にリンクされた href の値です。
  これを指定すると、image タグの周りに
  <literal>&lt;a href="LINKVALUE"&gt;&lt;a&gt;</literal>
  タグを配置します。
 </para> </listitem>

 <listitem><para>
  <parameter>path_prefix</parameter> には、任意で
  出力パスを指定できます。これは、画像を違うサーバに配置したい場合に有効です。
 </para></listitem>

 <listitem><para>
  前述の属性リストにないパラメータが与えられた場合は、作成された各
  <literal>&lt;img&gt;</literal> タグの内側に
  名前/値 のペアで表されます。
 </para></listitem>
</itemizedlist>

 <note>
  <title>テクニカルノート</title>
  <para>
   <varname>{html_image}</varname> は、画像を読み込んで幅と高さを取得するため、
   ディスクへのアクセスが必要です。テンプレートの <link linkend="caching">キャッシュ</link>
   を使用しない場合は、<varname>{html_image}</varname>
   ではなく静的に image タグを使用するほうがパフォーマンス的にお勧めです。
  </para>
 </note>

 <example>
  <title>{html_image} の例</title>
  <programlisting>
<![CDATA[
{html_image file='pumpkin.jpg'}
{html_image file='/path/from/docroot/pumpkin.jpg'}
{html_image file='../path/relative/to/currdir/pumpkin.jpg'}
]]>
  </programlisting>
  <para>
    上のテンプレートの出力
  </para>
  <screen>
<![CDATA[
<img src="pumpkin.jpg" alt="" width="44" height="68" />
<img src="/path/from/docroot/pumpkin.jpg" alt="" width="44" height="68" />
<img src="../path/relative/to/currdir/pumpkin.jpg" alt="" width="44" height="68" />
]]>
  </screen>
 </example>

</sect1>
<!-- 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:"../../../../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
-->