mirror of
https://github.com/php/doc-ru.git
synced 2025-08-11 02:43:11 +00:00
138 lines
4.6 KiB
XML
138 lines
4.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: 443d81b33e6537a000cc235c2a11748ba8d56232 Maintainer: bfl Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="function.highlight-file" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>highlight_file</refname>
|
||
<refpurpose>Подсвечивает синтаксис файла</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>
|
||
Выводит или возвращает версию с подсветкой синтаксиса кода, содержащегося
|
||
в файле <parameter>filename</parameter>, применяя цвета, которые определены
|
||
во встроенном обработчике подсветки синтаксиса PHP.
|
||
</para>
|
||
<para>
|
||
Многие серверы настроены с модулем <emphasis>phps</emphasis>, чтобы
|
||
автоматически подсвечивать файлы. Например,
|
||
при отображении файла <filename>example.phps</filename>
|
||
будет выведен код с подсветкой синтаксиса. Чтобы включить подстветку,
|
||
в файл &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>
|
||
Путь к PHP-файлу, который нужно подсветить.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>return</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Параметру устанавливают значение &true;, чтобы функция возвращала
|
||
подсвеченный код.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Если параметру <parameter>return</parameter> установлено значение &true;,
|
||
возвращает подсвеченный код в виде строки, а не выводит его. В остальных случаях
|
||
возвращает &true; в случае успешного выполнения или &false; в случае возникновения ошибки.
|
||
</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>
|
||
Изменился результирующий HTML.
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="notes">
|
||
&reftitle.notes;
|
||
<caution>
|
||
<para>
|
||
Рекомендовано пользоваться функцией <function>highlight_file</function>
|
||
с повышенным вниманием с тем, чтобы по неосторожности не раскрыть конфиденциальную
|
||
информацию, например, пароли или другую информацию, создающую
|
||
угрозу безопасности.
|
||
</para>
|
||
</caution>
|
||
¬e.uses-ob;
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>highlight_string</function></member>
|
||
<member><link linkend="ini.syntax-highlighting">Подсвечивание директив 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
|
||
-->
|