highlight-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 443d81b33e6537a000cc235c2a11748ba8d56232 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 3c699fad2dd94ee926ba04bdaf79e6f14b5b728b Reviewer: samesch -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>Syntax-Hervorhebung für eine Datei</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>
   Erzeugt die hervorgehobene Syntax des Codes der Datei
   <parameter>filename</parameter> als Ausgabe oder als Rückgabewert. Dabei
   werden die im eingebauten Syntax-Highlighter für PHP definierten Farben
   benutzt.
  </para>
  <para>
   Viele Server sind so konfiguriert, dass sie den Code von Dateien mit der
   <emphasis>phps</emphasis>-Erweiterung automatisch hervorheben. Wenn zum
   Beispiel <filename>beispiel.phps</filename> aufgerufen wird, wird die
   hervorgehobene Syntax des Quellcodes der Datei angezeigt. Mit der folgenden
   Zeile in der &httpd.conf; wird dies aktiviert:
  </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>
       Der Pfad zur PHP-Datei, deren Code hervorgehoben werden soll.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       Wenn dieser Parameter auf &true; gesetzt wird, gibt die Funktion den
       hervorgehobenen Code zurück.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Falls <parameter>return</parameter> auf &true; gesetzt ist, wird der
   hervorgehobene Code nicht direkt ausgegeben, sondern als Zeichenkette
   zurückgegeben. Andernfalls wird bei Erfolg &true; zurückgegeben und
   &false;, falls ein Fehler auftritt.
  </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>
        Das resultierende HTML wurde geändert.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Wenn <function>highlight_file</function> verwendet wird, sollte darauf
    geachtet werden, dass nicht versehentlich vertrauliche Informationen wie
    Passwörter oder andere Informationen, die ein potentielles
    Sicherheitsrisiko schaffen könnten, verraten werden.
   </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-Direktiven für Highlighting</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
-->