1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.22 -->
<refentry id="function.highlight-file">
<refnamediv>
<refname>highlight_file</refname>
<refpurpose>Syntax highlighting of a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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></methodparam>
</methodsynopsis>
<simpara>
The <function>highlight_file</function> function prints out a syntax
highlighted version of the code contained in <parameter>filename</parameter>
using the colors defined in the built-in syntax highlighter for PHP.
</simpara>
<simpara>
If the second parameter <parameter>return</parameter> is set to &true;
then <function>highlight_file</function> will return the highlighted
code as a string instead of printing it out. If the second parameter is
not set to &true; then <function>highlight_file</function> will
return &true; on success, &false; on failure.
</simpara>
¬e.uses-ob;
<note>
<simpara>
The <parameter>return</parameter> parameter became available in PHP
4.2.0. Before this time it behaved like the default, which is &false;
</simpara>
</note>
<note>
<simpara>
Since PHP 4.2.1 this function is also affected by <link
linkend="ini.safe-mode">safe_mode</link> and <link
linkend="ini.open-basedir">open_basedir</link>.
</simpara>
</note>
<caution>
<simpara>
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.
</simpara>
</caution>
<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>
<simpara>
See also <function>highlight_string</function>.
</simpara>
</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:"../../../../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
-->
|
