__halt_compiler
From W on 20 August 2008:
YES! I do it too, on many of my things! I love to be able to share my code (when I have the right to do it) with friends who aren't working on the project.
<?php
if (isset($_GET['code'])) { die(highlight_file(__FILE__, 1)); }
?>
I like to do it like this. The benefit is minimal but personally for such a small thing I would like to keep it down to one line. Maybe there is a shorter way, I don't know.. But the magic constant __FILE__ saves the day!
To access this one would be http://example.com/path/to/script.php?code
the parameter just has to be set (? or &) and you don't need the equals sign.
This way I don't generate any errors in E_ALL (because I'm likely in development), and I don't have to remember if the value was supposed to be "true" or "1" or "abacus" or whatever (I mean you're never going to specifically ask to NOT show the code, right?)
Anyway I've gone on long enough. It's nice to not be the only one who does this :D
highlight_file
(PHP 4, PHP 5)
highlight_file — Syntax highlighting of a file
Popis
mixed highlight_file
( string $filename
[, bool $return
] )
Prints out or returns a syntax highlighted version of the code contained in filename using the colors defined in the built-in syntax highlighter for PHP.
Many servers are configured to automatically highlight files with a phps extension. For example, example.phps when viewed will show the syntax highlighted source of the file. To enable this, add this line to the httpd.conf:
AddType application/x-httpd-php-source .phps
Parametre
- filename
-
Path to the PHP file to be highlighted.
- return
-
Set this parameter to TRUE to make this function return the highlighted code.
Vrátené hodnoty
If return is set to TRUE, returns the highlighted code as a string instead of printing it out. Otherwise, it will return TRUE on success, FALSE on failure.
ChangeLog
| Verzia | Popis |
|---|---|
| 4.2.1 | This function is now also affected by safe_mode and open_basedir. |
| 4.2.0 | The return parameter was added. |
Poznámky
Caution
Care should be taken when using the highlight_file() function to make sure that you do not inadvertently reveal sensitive information such as passwords or any other type of information that might create a potential security risk.
Note: This function internally uses the output buffering with this parameter so it can not be used inside ob_start() callback function.
add a note
User Contributed Noteshighlight_file
SneakyWho_am_i
10-Sep-2008 04:00
10-Sep-2008 04:00
W
20-Aug-2008 02:43
20-Aug-2008 02:43
Normally I add highlighting for files like so:
In every file that should be higlighted:
<?php
$tool_file=$_SERVER['SCRIPT_FILENAME']; $tool_file=basename($tool_file);
include_once('highlight.inc.php');
showCode();
?>
And in highlight.inc.php (or your init file):
<?php
function showCode() {
if ($_REQUEST['codeShow'] == 1) {
highlight_file($codeName);
exit ();
}
}
?>
When a user will open the sourcecode (or you'll link to it) he just adds ?codeShow=1 to the filename.
mmcloughlin at gmail dot com
09-May-2008 06:06
09-May-2008 06:06
You can trick this function to apply additional css rules to parts of the source code.
For example, if you wanted comments to appear in bold you could do the following
<?php
ini_set('highlight.comment', '#CCCCCC; font-weight: bold;');
highlight_file('file.php');
?>
This works because when highlight_file() writes out a comment it wraps it in <span style="color: {contents of hightlight.comment ini variable}">...</span>. Therefore as long as your ini value for highlight.comment starts with a color, you can put in whatever style declarations you like.
This applies to all of the other relavent ini values: highlight.default, highlight.html, highlight.keyword, highlight.string.
comperr dot extra at gmail dot com
18-Apr-2008 11:20
18-Apr-2008 11:20
Here is what I use
<?php
/* array() ensures that ok[] cannot have paths inserted if register globals is enabled */
$ok = array(
'f1.php',
'f2.php'
);
if (!in_array($_GET['f'], $ok))
{
die ('Not allowed to view this page');
}
else
{
highlight_file($_GET['f']);
}?>
moisadoru at gmail dot com
17-Oct-2007 05:24
17-Oct-2007 05:24
A function which parses the output of highlight file and replaces <span> wits <a>, replaces the style="color: #XXXXXX" part with class="cX", storing the colors in some css rules; that way you get a smaller output size (ratio is about about 1.2 ~ 1.4):
<code>
<?php
function highlight_file2($fl,$ret){
if(!isset($ret)) $ret = false;
$str = highlight_file($fl,true);
preg_match_all("/\<span style=\"color: #([\d|A|B|C|D|E|F]{6})\"\>.*?\<\/span\>/",$str,$mtch);
$m = array_unique($mtch[1]);
$cls = '<style type="text/css">'."\n";
$rpl = array("</a>");
$mtc = array("</span>");
$i = 0;
foreach($m as $clr) {
$cls .= "a.c".$i."{color: #".$clr.";}\n";
$rpl[] = "<a class=\"c".$i++."\">";
$mtc[] = "<span style=\"color: #".$clr."\">";
}
$cls .= "</style>";
$str2 = str_replace($mtc,$rpl,$str);
if($ret) return $str2;
else echo $str2;
}
?>
</code>
thinbegin at unmannedship dot com
18-Aug-2007 10:45
18-Aug-2007 10:45
i much prefer to use the .phps extension for showing highlighted source. all you have to do is type "cp example.php example.phps" at the command line.
on the flip side, for easy dynamic source sharing, it's as simple as:
<?php
if (!isset($_GET['file']) || trim($_GET['file']) == '') {
echo 'please pass me something yummy';
die(0);
}
if (!file_exists($_GET['file'])) {
echo "<b>{$_GET['file']}</b> does not seem to exist :(";
die(0);
}
highlight_file($_GET['file']);
?>
management at twilightus dot net
20-Mar-2007 07:18
20-Mar-2007 07:18
Here's a better take at highlighting a file with line numbers:
<style type="text/css">
.num {
float: left;
color: gray;
text-align: right;
margin-right: 6pt;
padding-right: 6pt;
border-right: 1px solid gray;}
</style>
<?php
function highlight_num($file)
{
echo '<code class="num">', implode(range(1, count(file($file))), '<br />'), '</code>';
highlight_file($file);
}
highlight_num('file.php');
?>
Thanks for the implode() part from Arevos at programmingforums.org
jens dot grasnick at gmail dot com
06-Oct-2006 06:38
06-Oct-2006 06:38
Hi there, i build a "little" class to controll the highlighting functions (highlight_source & highlight_file) of PHP a little bit more. You can:
- set the highlighting colors without rewrite your php.ini
-create a whitelist using by highlightFile - so your're surly that nobody take a look on your private source ;-)
- work with the highlighted content - it returns the highlighted content, not show it like highlight_file or highlight_source did.
Class:
<?php
class betterHighlighting {
/* user colors */
private $userColors = array(
"string" => "",
"comment" => "",
"keyword" => "",
"bg" => "",
"default" => "",
"html" => "",
);
/* array of allowed file for using by ::highlightFile() */
private $whitelist = array();
/* construct */
function __construct($allowedFiles = NULL, /* array or NULL */
$newColors = NULL /* array or NULL */) {
/* add (if some given) files to the highlighting whitelist */
if($allowedFiles) {
$this -> addFiles($allowedFiles);
}
/* set highlighting colors */
if($newColors) {
$this -> setColors($newColors);
}
}
/* for adding files to the whitelist */
public function addFiles($allowedFiles /* array or string */) {
$file = is_array($allowedFiles) ? array_pop($allowedFiles) : $allowedFiles;
if(file_exists($file)) {
$this -> whitelist[] = $file;
} else
if(is_array($allowedFiles) && sizeof($allowedFiles)) {
$this -> addFiles($allowedFiles);
}
return void;
}
/* for setting new userColors */
public function setColors($newColors = array()) {
foreach($newColors as $key => $color) {
if(in_array($key, array_keys($this -> userColors))) {
$this -> userColors[$key] = $color;
}
}
}
/* replaces default colors with users colors */
private function putColors($highlightedContent) {
$nHC = $highlightedContent;
$hTpl = "<span style=\"color: %s\">";
foreach($this -> userColors as $key => $color) {
if(!empty($color)) {
$nHC = str_replace(sprintf($hTpl, ini_get("highlight.{$key}")), sprintf($hTpl, $color), $nHC);
}
}
return $nHC;
}
/* highlight's a string */
public function highlightString($string) {
$hC = "";
ob_start();
highlight_string($string);
$hC = ob_get_contents();
ob_end_clean();
return $this -> putColors($hC);
}
/* highlight's a file */
public function highlightFile($file) {
if(in_array($file, $this -> whitelist)) {
return $this -> highlightString(join("", file($file)));
}
return "";
}
}
?>
Usage:
$cl = new betterHighlighting([mixed files], [mixed colors]);
To put a file or a array of files to the whitelist, use (void) ::addFiles(mixed files).
To set a new color for highlighting use (void) ::setColors(array("string" => ..., "comment" => ..., "keyword" => ..., "bg" => ..., "default" => ..., "html" => ...)).
You only have to give the keyword(s), which color you'll change. If you only want to change the color of the highlighted comments, call ::setColors(array("comment" => "newcolor")) and so on.
Highlighting String:
(string)::highlightString(string $source)
Highlighting File:
(string)::highlightFile(string $file)
Note: The two last function RETURNS the highlighted content, not shows it directly.
Little example: I want to highlight the file "test.php" and the comments should be pink.
<?php
$cl = betterHighlighting("test.php", array("comment" => "pink"));
echo $cl -> highlightFile("test.php");
?>
Have fun.
paul at cheddar dot vaughany dot com
21-Aug-2006 04:53
21-Aug-2006 04:53
It's a basic idea but one maybe worth sharing.
<?php
switch($_GET['file']) {
case 1:
highlight_file("file1.php");
break;
case 2:
highlight_file("file2.php");
break;
case 3:
highlight_file("file3.php");
break;
default:
header("Location: ".$_SERVER["PHP_SELF"]);
}
?>
Save the script as showfile.php and access it like this:
<a href="showfile.php?file=1">Click here to see file 1 source code</a>
The default case is for people editing the URL to try to access further files. Just don't add any files you don't want users to see, and maybe hard-code in large, random numbers or MD5 hashes.
showsource at gmail dot com
07-Apr-2006 05:18
07-Apr-2006 05:18
Please, be aware of just using marlon at mbwp dot nl example to show the sourcecode
Do as told in this manual, "CAUTION", do some check on what code to highlight.
Simply just using $_GET["file"] is very bad.
marlon at mbwp dot nl
05-Mar-2006 05:06
05-Mar-2006 05:06
I use the folowing code to highlight a file with line numbers:
<?php
echo "<table bgcolor=#EEEEEE><tr><td width=30>";
for ($i = 1; $i <= count(file($_GET['file'])); $i++) echo $i.".<br>";
echo "</td><td>";
highlight_file($_GET['file']);
echo "</td></tr></table>";
?>
msn at toolskyn dot nl
26-Feb-2006 01:18
26-Feb-2006 01:18
I use this (simple and dirty) function in my tutorials to add linenumbers. I let all the linenumbers in one table cell so it is easier for people to copy and paste the code (so they don't have to remove all the linenumbers):
<?php
function highlight_with_linenum($file)
{
//open handle, set vars
$handle = fopen($file, "r");
$count = 1;
$lines = "";
//look line ends
while ($thisone = fread($handle, "1"))
{
if ($thisone == "\n")
{
//add number
$lines .= $count . "<br />";
$count++;
}
}
//close handle
fclose($handle);
//highlight contents
$contents = highlight_file($file, TRUE);
//print output (you could as well return now)
print '<table><tr><td><code>' .
$lines . '</code></td><td>' .
$contents . '</td></tr></table>';
}
?>
Maybe it's of use to someone
ganchev at design dot bg
13-Jan-2006 12:40
13-Jan-2006 12:40
here's a simple way to add line numbers and
optionally highlight the one that has error on it.
just pass file and line arguments as GET variables
<?php
$f = fopen($_GET['file'], "r");
$count = 1;
$line = "";
echo "<table>";
while ($c = fread($f, "1")) {
$line .= $c;
if ($c == "\n") {
echo "<tr style='background: " . (($_GET['line'] == $count) ? "#eedddd" : "#ffffff") . "'><td width='10%'>$count.</td><td>" . highlight_string($line, TRUE) . "</td></tr>\n";
$line = "";
$count++;
}
}
echo "</table>";
fclose($f);
?>
dtroi50 at gmail dot com
09-Jan-2006 02:39
09-Jan-2006 02:39
If you run a site that has PHP script examples and you want to show the source, instead of a phps file, just add the following code to the top of the script.
<?php
if(count($_GET)) {
highlight_file(__FILE__);
}
?>
Then to make a source link use this:
<?php
print'<a href="?source">Show source</a>';
?>
Note that you don't have to use souce. If any get variables are set, it'll work.
-Tom
venski at gmail dot com
06-Jan-2006 05:21
06-Jan-2006 05:21
I think it will be better if the variable contains the files that are allowed to be viewed. There can always befound a way to pass the name of a forbiddedn file that is not in the prohibited array.
Thus the code will be:
<?php
//array with files to allow
$allowed = array('index.php', 'menu.php', 'about.php');
// get the filename
$file = $_GET[file];
if(file_Exists($file)){
if(in_array($file, $allowed)){
// check if it is part of the allowed list
highlight_file($file); //highlight file
}
else{
// not allowed. just die. do not warn ;)
die("");
}
}
else{
// file doesnt exist
echo "The file does not exist.";
}
?>
trukin at gmail dot com
08-Dec-2005 07:46
08-Dec-2005 07:46
this function can be a high security risk. use something like in_array to check if a file is prohibited to be shown on screen.
<?
$ar= array('config.php', 'index.php', 'functions.php'); //array with files to denie
$file = $_GET[file]; // iniziate the variable
if(file_Exists($file)){
if(!in_array($file, $ar)){ // check if it is prohibited
highlight_file($file); //highlight file
}else{ // prohibited file
echo "You do not have permision to see the ".$file." file.";
}
}else{ // file doesnt exist
echo "That file does not exist.";
}
?>
Michael Newton (http://mike.eire.ca/)
06-Dec-2005 09:48
06-Dec-2005 09:48
To print out the current file:
<?php highlight_file( __FILE__ ); ?>
Useful to add this as a header to all scripts (during development only, of course!)
<?php
if ($_GET['debug']) {
highlight_file( __FILE__ );
exit;
}
?>
Vlad Alexa Mancini valexa at nextcode dot org
21-Feb-2005 11:19
21-Feb-2005 11:19
Here is a small bash script that you can type at the console to make recursive symbolic .phps links for all your .php files starting at your curent directory
for f in `find -name '*.php'`; do ln -s `basename $f` $f's'; done
NOTE: You doubtedly want to do this at / as it will make such symlinks for all the php files on your filesystem
NOTE: This places the symlinks in the same directory as the php file that they are simlinking
And a simpler one that is not recursive and does the same thing but only for the php files in your current directory
for f in *.php; do ln -s $f $f's'; done
aidan at php dot net
26-Sep-2004 08:29
26-Sep-2004 08:29
To add line numbers to source code, with optional function linking, use the below function:
http://aidanlister.com/repos/v/function.highlight_file_linenum.php
A much more thorough and smarter, though slower version is here:
http://aidanlister.com/repos/v/PHP_Highlight.php
csst0266 at cs dot uoi dot gr
13-Aug-2004 09:42
13-Aug-2004 09:42
Here is a simple, yet useful, tip... Issuing the following command under a Unix-like OS:
ln -s your_script.php your_script.phps
Will result in the creation of a symbolic link (called your_script.phps) to the source code (your_script.php). This way you have (apart from the source code .php) the highlighted version of your script (.phps) accessible via your web browser.
zan at stargeek dot com
08-Jan-2003 10:24
08-Jan-2003 10:24
here's how to use highlight_file to create a browseable archive of php scripts http://www.stargeek.com/scripts.php?script=7&cat=blog