<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>Syntax highlighting of a file</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>
   Prints out or returns a syntax highlighted version of the code contained
   in <parameter>filename</parameter> using the colors defined in the
   built-in syntax highlighter for PHP.
  </para>
  <para>
   Many servers are configured to automatically highlight files
   with a <emphasis>phps</emphasis> extension. For example,
   <filename>example.phps</filename> when viewed will show the
   syntax highlighted source of the file. To enable this, add this
   line to the &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>
       Path to the PHP file to be highlighted.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       Set this parameter to &true; to make this function return the
       highlighted code.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If <parameter>return</parameter> is set to &true;, returns the highlighted
   code as a string instead of printing it out. Otherwise, it will return
   &true; on success, &false; on failure.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Care should be taken when using the <function>highlight_file</function>
    function to make sure that you do not inadvertently reveal sensitive
    information such as passwords or any other type of information that might
    create a potential security risk.
   </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">Highlighting INI directives</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
-->
