Source of: /manual/es/function.highlight-file.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.misc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'es',
),
'this' =>
array (
0 => 'function.highlight-file.php',
1 => 'highlight_file',
),
'up' =>
array (
0 => 'ref.misc.php',
1 => 'Funciones Varias',
),
'prev' =>
array (
0 => 'function.halt-compiler.php',
1 => '__halt_compiler',
),
'next' =>
array (
0 => 'function.highlight-string.php',
1 => 'highlight_string',
),
'alternatives' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.highlight-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">highlight_file</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">highlight_file</span> — <span class="dc-title">Remarcado de sintaxis de un archivo</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.highlight-file-description">
<h3 class="title">Descripción</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>highlight_file</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$return</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Imprime o devuelve una versión con la sintaxis remarcada del código contenido en el archivo
dado por <em><code class="parameter">filename</code></em> usando los colores definidos en el
remarcador de sintaxis interno de PHP.
</p>
<p class="para">
Muchos servidores están configurados para remaracar automáticamente archivos
con la extensión <em class="emphasis">phps</em>. Por ejemplo,
<var class="filename">example.phps</var> cuando se vea mostrará la
fuente con la sintaxis remarcada del archivo. Para habilitar esto, añada esta
línea a <var class="filename">httpd.conf</var>:
</p>
<div class="example-contents screen">
<div class="descriptioncode"><pre class="descriptioncode">AddType application/x-httpd-php-source .phps</pre>
</div>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.highlight-file-parameters">
<h3 class="title">Parámetros</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
Ruta al archivo PHP a ser remarcado.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">return</code></em></span>
<dd>
<p class="para">
Establezce este parámetro a <strong><code>TRUE</code></strong> para hacer que esta función devuelva el
código remarcado.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.highlight-file-returnvalues">
<h3 class="title">Valores devueltos</h3>
<p class="para">
Si <em><code class="parameter">return</code></em> está establecido a <strong><code>TRUE</code></strong>, devuelve el código
remarcado como cadena en vez de imprimirlo. De otro modo, devolverá
<strong><code>TRUE</code></strong> en caso de éxito, y <strong><code>FALSE</code></strong> en caso de fallo.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.highlight-file-changelog">
<h3 class="title">Historial de cambios</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Versión</th>
<th>Descripción</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.2.1</td>
<td>
Esta función ahora le afecta <a href="ini.sect.safe-mode.php#ini.safe-mode" class="link">safe_mode</a> y <a href="ini.core.php#ini.open-basedir" class="link">open_basedir</a>.
</td>
</tr>
<tr>
<td>4.2.0</td>
<td>
Se añadió el parámetro <em><code class="parameter">return</code></em>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.highlight-file-notes">
<h3 class="title">Notas</h3>
<div class="caution"><strong class="caution">Precaución</strong>
<p class="para">
Se debería tener cuidado al usar la función <span class="function"><strong>highlight_file()</strong></span>
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.
</p>
</div>
<blockquote class="note"><p><strong class="note">Nota</strong>: <p class="para">Cuando el parámetro <em><code class="parameter">return</code></em>
se usa, esta función utiliza el almacenamiento en búfer de salida interno, por lo que no puede usarse dentro de una
función de llamada de retorno <span class="function"><a href="function.ob-start.php" class="function">ob_start()</a></span>.</p></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.highlight-file-seealso">
<h3 class="title">Ver también</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.highlight-string.php" class="function" rel="rdfs-seeAlso">highlight_string()</a> - Remarcado de sintaxis de una cadena</span></li>
<li class="member"><a href="misc.configuration.php#ini.syntax-highlighting" class="link">Directivas INI de resaltado</a></li>
</ul>
</p>
</div>
</div><?php manual_footer(); ?>
