構文ハイライト表示

クラスの作成経緯

本サイトでのPHPソースの公開に際して、拡張子が違えど中身が同じ２つのファイル（拡張子がphpとphpsのファイル）を態々用意したくはありませんでした。そこで、Apacheの設定ファイル（.htaccess）に次のような記述を書いて試してみましたが駄目でした。

RewriteRule ^(.*)\.phps$ $1\.php [T=application/x-httpd-php-source, L]

そこで、highlight_file関数を使った簡素なソース表示用スクリプトを書いてみました。ただ、highlight_file及びhighlight_string関数（PHP組込みの構文ハイライタ）の出力は、X/HTMLとして好ましいものではありません。そこで、即席ですが構文ハイライト表示の為のクラスを作成しました。

HighlightSourceクラス

public class HighlightSource extends Object

HighlightSourceStrictクラス

public class HighlightSourceStrict extends HighlightSource

クラスの使用例

次の例は、HighlightSourceクラスを使用したサンプルです。

<?php
ini_set("include_path", "./");
// require_once("org/purl/net/osamurai/misc/HighlightSource.php"); // for PHP 4
require_once("misc/HighlightSource.php"); // for PHP 5

$phps = new HighlightSource;
$filename = 'foo.php';
$highlight = array('string' => "#DD0000", 'comment' => "#FF8000", 'keyword' => "#007700",
                   'bg' => "#FFFFFF", 'default' => "#0000BB", 'html' => "#000000");
$phps->setHighlight($highlight);
echo $phps->dump($filename);

unset($phps);
?>

上の例の出力は、highlight_file関数を使用した時と同じ結果を返します。この際、setHighlightメソッドで設定した色が表示色として反映されます。このHighlightSourceクラスを厳密なHTMLを返すように拡張したクラスがHighlightSourceStrictクラスです。

次の例は、HighlightSourceStrictクラスを使用したサンプルです。

<?php
ini_set("include_path", "./");
// require_once("org/purl/net/osamurai/misc/HighlightSourceStrict.php"); // for PHP 4
require_once("misc/HighlightSourceStrict.php"); // for PHP 5

$phps = new HighlightSourceStrict;
$filename = 'foo.php';
$highlight = array('string' => "#DD0000", 'comment' => "#FF8000", 'keyword' => "#007700",
                   'bg' => "#FFFFFF", 'default' => "#0000BB", 'html' => "#000000");
$phps->setHighlight($highlight);
echo $phps->dump($filename);

unset($phps);
?>

上の例の出力は、次のようになります。

<pre class="php-highlight"><code class="html"><code class="default">&lt;?php phpinfo</code><code class="keyword">();</code> <code class="default">?&gt;</code></code></pre>

概要

構文ハイライト表示クラスを使用した、PHPファイルのソースコードを表示する為のスクリプトです。本サイトでのPHPソースの公開にも使用しているスクリプトです。

ファイル一覧

設定

必要であれば、設定ファイル（define.php）で動作設定が行えます。設定ファイルをテキストエディッタで開き、コメント記述を参考にしながら編集して下さい。

使用方法

変換対象となるファイルのパスをView.phpのクエリーpathに指定して使用します。クエリーpathに指定する変換対象のファイルのパスは、設定ファイルの変数$ROOT_DIRで指定されたディレクトリを起点としたパスを指定します。

http://www.example.com/psv/view.php?path=/foo.php

サーバソフトウェアがApacheで、尚且つmod_rewriteモジュールが使用可能ならば、.htaccessファイルに次のような記述をすることで、拡張子がphpsのパスで要求された際にView.phpでソースを表示することができます（下記例では、phpsファイルがある場合には、それを使います）。

RewriteEngine on
# 基となる名前に名前をrewriteして、php拡張子で存在確認する。
# もし存在すれば、その名前を取り、そうでなければオリジナルの状態（phps）のURLにrewriteする。
RewriteRule ^(.*)\.phps$ $1 [C,E=WasPHPS:yes]
RewriteCond %{REQUEST_FILENAME}.php -f
RewriteRule ^(.*)$ /php/psv/View.php?path=%{REQUEST_FILENAME}.php [S=1]
RewriteCond %{ENV:WasPHPS} ^yes$
RewriteRule ^(.*)$ $1.phps [L]

参考資料

Apache module mod_rewrite

Apache URL Rewriting Guide