php-doc-en/reference/misc/functions/highlight-string.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.22 -->
  <refentry id="function.highlight-string">
   <refnamediv>
    <refname>highlight_string</refname>
    <refpurpose>Syntax highlighting of a string</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>highlight_string</methodname>
      <methodparam><type>string</type><parameter>str</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     The <function>highlight_string</function> function outputs a syntax
     highlighted version of <parameter>str</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_string</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_string</function> will
     return &true; on success, &false; on failure.
    </simpara>
    <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>
    <simpara>
     See also <function>highlight_file</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
-->