highlight-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 443d81b33e6537a000cc235c2a11748ba8d56232 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>ファイルの構文ハイライト表示</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>bool</type></type><methodname>highlight_file</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>return</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>filename</parameter> の中のコードを構文ハイライト表示して
   出力します。色は、PHP 組込の構文ハイライタで定義されているものを使用します。
  </para>
  <para>
   多くのサーバーでは、拡張子が <emphasis>phps</emphasis> のファイルは
   自動的に構文ハイライト表示されるように設定されています。例えば
   <filename>example.phps</filename> のようなファイルは、構文ハイライト
   したソースファイルとして表示されます。これを有効にするには、
   &httpd.conf; に以下のような行を追加します。
  </para>
  <screen>
<![CDATA[
AddType application/x-httpd-php-source .phps
]]>
  </screen>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       ハイライト表示する PHP ファイルへのパス。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       このパラメータを &true; にすると、この関数はハイライトされたコードを返します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>return</parameter> が &true; の場合は、
   ハイライトされたコードを文字列として返し、表示しません。
   それ以外の場合は、成功した場合に &true;、
   失敗した場合に &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>8.3.0</entry>
       <entry>
        結果のHTMLが変更されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    <function>highlight_file</function> 関数を使用する場合には、
    パスワードやその他潜在的なセキュリティ上の危険を生む類の重要な
    情報を不注意で公開してしまわないように注意する必要があります。
   </para>
  </caution>
  &note.uses-ob;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>highlight_string</function></member>
    <member><link linkend="ini.syntax-highlighting">ハイライトに関する INI 設定</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
-->