What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

highlight_string
Prev	XXXIX. Miscellaneous Functions	Next

highlight_string

Name

highlight_string — Applies PHP syntax highlight to a string.

Synopsis

bool highlight_string([. . .]); string . . . (optional): Complete piece of PHP code (including start and end tags <?php ... ?>)

Returns

TRUE on success; FALSE on failure

Description

highlight_string() is used to apply PHP syntax highlighting to a string and then display it. The syntax highlighting is applied using HTML tags. The function returns TRUE on success and FALSE on failure.

The colors used for highlighting can be set in the php.ini file. They can also be set using the ini_set() function (see highlight_file() for an example).

Note

The string passed should contain PHP code block start and end tags if it is to be properly highlighted; for example, 'printf ("%0.2d", 0x2)' will not be highlighted, while '<?php printf ("%0.2d", 0x2) ?>' will be highlighted.

Version

PHP Version: 4+

Example

Example 758. Highlight a code snippet, remove the PHP code block tags, and display it

<?php
$snippet = '<?php
function export ($var)
{
    if ($this->locals[$var])
    {
        $this->globals[$var] = $GLOBALS[$var];
        return TRUE;
    }

    return FALSE;
}
?>';

# Start capturing script output
ob_start();

# Highlight the code snippet
highlight_string ($snippet);

# Place the script output in a variable
$highlighted_snippet = ob_get_contents ();

# Stop capturing the script output and discard the captured output
ob_end_clean ();

# Display the captured output after removing the PHP block tags.
# highlight_string() will convert <?php ?> to &lt;?php ?&gt;
# Make sure that the regular expression can handle this.
echo eregi_replace ('(&lt;\?php|\?&gt;)', '', $highlighted_snippet);
?>

Prev	Home	Next
highlight_file	Up	iptcparse

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.