highlight_file

(PHP 4 , PHP 5)

highlight_file -- ファイルの構文ハイライト表示

説明

bool highlight_file ( string filename)

関数 highlight_file()は、 filenameの中のコードをPHP組込の構文ハイラ イタで定義されたカラーを使用して構文ハイライト表示したものを出力 します。この関数は、成功時にTRUE、その他の場合にFALSEを返します。 (PHP 4)

注意: 関数 show_source() および highlight_file()を使用する場合には、パスワー ドや潜在的なセキュリティ上の危険を生む類の他の情報のような重要な 情報を不注意で公開してしまわないように注意する必要があります。

例 1. URLのソースハイライト表示の作成

引数として指定したスクリプトのコードをハイライト表示できるよう なURLを設定する際には、適したURLパターンを生成するためにApache の "ForceType" ディレクティブを使用し、見栄えの良いコー ドリストを表示するために関数highlight_file() を使用します。

httpd.confに次のような記述を追加します。

<Location /source>
    ForceType application/x-httpd-php
</Location>

そして、"source"という名前のファイルを作成し、それをWebのルート ディレクトリに置きます。

<HTML>
<HEAD>
<TITLE>Source Display</TITLE>
</HEAD>
<BODY BGCOLOR="white">
<?php
    $script
= getenv ("PATH_TRANSLATED");
    if(!
$script) {
    echo
"<BR><B>ERROR: Script Name needed</B><BR>";
    } else {
    if (
ereg("(\.php|\.inc)$",$script)) {
    echo
"<H1>Source of: $PATH_INFO</H1>\n<HR>\n";
    
highlight_file($script);
    } else {
    echo
"<H1>ERROR: Only PHP or include script names are allowed</H1>";
    }
    }
    echo
"<HR>Processed: ".date("Y/M/d H:i:s",time());
?>
</BODY>
</HTML>

これにより、"/path/to/script.php"にあるスクリプトのカラー表示を 表示するために以下のURLを使用することができるようになります。

http://your.server.com/source/path/to/script.php

ティップ: ブラウザに直接結果を出力する 全てのものと同様に、出力制御関数 を使用してこの関数の出力をキャプチャーし、(例えば)文字列 (string)に保存することが可能です。

highlight_string(), show_source()も参照下さい。