highlight-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b824e2b1086e94a1077bd071964547283616030a Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>highlight_file</refname>
  <refpurpose>Remarcado de la sintaxis de un fichero</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>
   Imprime o devuelve una versión con la sintaxis remarcada del código contenido en el fichero
   dado por <parameter>filename</parameter> usando los colores definidos en el
   remarcador de sintaxis interno de PHP.
  </para>
  <para>
   Muchos servidores están configurados para remaracar automáticamente ficheros
   con la extensión <emphasis>phps</emphasis>. Por ejemplo,
   cuando se visione <filename>example.phps</filename> mostrará la
   fuente con la sintaxis remarcada del fichero. Para habilitar esto, añada esta
   línea a &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>
       Ruta al fichero PHP a ser remarcado.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return</parameter></term>
     <listitem>
      <para>
       Establecer este parámetro a &true; para hacer que esta función devuelva el
       código remarcado.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si <parameter>return</parameter> está establecido a &true;, devuelve el código
   remarcado como string en vez de imprimirlo. De otro modo, devolverá
   &true; en caso de éxito, y &false; en caso de error.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <caution>
   <para>
    Se debería tener cuidado al usar la función <function>highlight_file</function>
    para asegurarse de que no se revela inadvertidamente información
    sensible como contraseñas o cualquier otro tipo de información que podría
    crear un riesgo potencial de seguridad.
   </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">Directivas INI de resaltado</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
-->