highlight-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b824e2b1086e94a1077bd071964547283616030a Maintainer: reghe Status: ready -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>Evidenziatore di sintassi per un file</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</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>
   Stampa o ritorna una versione del codice contenuto nel file di nome <parameter>filename</parameter>
   con la sintassi evidenziata usando i colori predefiniti nel
   syntax highlighter per PHP.
  </para>
  <para>
   Molti server sono configurati per evidenziare i file automaticamente
   con l'estensione <emphasis>phps</emphasis>. Per esempio,
   <filename>example.phps</filename> mostrerà la sintassi evidenziata
   del codice sorgente del file. Per abilitarlo, aggiungere questa
   riga nell'&httpd.conf; (su webserver Apache):
  </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>
       Percorso del file PHP che deve essere evidenziato.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       Se settato a &true; la funzione ritornerà il
       codice evidenziato anziché stamparlo.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Se <parameter>return</parameter> è &true;, ritorna il codice evidenziato
   come una stringa invece di stamparlo. Altrimenti, ritornerà
   &true; in caso di successo o &false; in caso di fallimento.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Prestare attenzione quando si usa la funzione <function>highlight_file</function>,
    assicurandosi di non rivelare inavvertitamente dati
    sensibili come password o altri tipi di informazioni che possono
    causare potenziali rischi di sicurezza.
   </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">Evidenziare direttive 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
-->