<?php
/*
* RTF Generation PHP Class
* ------------------------
* ** Based on a project found on phpclasses.org - Can't find it anymore... :(
*
* FIXES AND MORE:
* ---------------
* 1. Enhanced color support
* 2. Font support added (6 fonts for now)
* 3. Image support added (a bit buggy but working)
* 4. Color defines added for simple reference
* 5. List support added
* 6. Fix for some special characters (words with accents)
* 7. Fix for text and image alignment
* 8. Page jump support added ( see new_page() )
* 9. Minor fixes
* ===============================================================
* DISCLAIMER:
* ===============================================================
*
* This php class is distributed as-is.
* So do not bother for broken functions, nor any non-working thing.
*
* If you find a bug please notify me... and if you can, please attach the solution!!!
*
* Hints and suggestions are welcome!!!
*
* Michele
* michele (at) xtnet (dot) it
*
*/
// START OF COLOR TABLE
define('BLACK', 0);
define('DARKGRAY', 1);
define('LIGHTBLUE', 2);
define('CYAN', 3);
define('LIGHTGREEN', 4);
define('PURPLE', 5);
define('RED', 6);
define('YELLOW', 7);
define('WHITE', 8);
define('BLUE', 9);
define('DARKCYAN', 10);
define('DARKGREEN', 11);
define('DARKPURPLE',12);
define('BROWN', 13);
define('DARKYELLOW',14);
define('GRAY', 15);
define('LIGHTGRAY', 16);
define('ORANGE', 17);
define('LIGHTGRAY2', 18);
// END OF COLOR TABLE
class RTF
{
var $MyRTF;
var $dfl_FontID;
var $dfl_FontSize = 20;
var $FontID;
var $TextDecoration;
/**
* Creates the RTF file on RAM and writed the header
* including the font table and the color table
*
* see also: load_color_table() e load_font_table()
*
* @return void
*
*/
function __construct($landscape = false)
{
$this->MyRTF="{\\rtf1\\ansi\n";
if($landscape)
$this->MyRTF .= "\landscape\paperw15840\paperh12240\margl720\margr720\margt720\margb720";
$this->load_color_table();
$this->load_font_table();
$this->MyRTF .= "\n{\n\n";
}
/**
* Loads the color table (RGB)
*
* @return void
*
*/
function load_color_table()
{
$this->MyRTF.="{\\colortbl;\n".
"\\red0\\green0\\blue0;\\red0\\green0\\blue255;\\red0\\green255\\blue255;\n".
"\\red0\\green255\\blue0;\\red255\\green0\\blue255;\\red255\green0\\blue0;\n".
"\\red255\\green255\\blue0;\\red255\\green255\\blue255;\\red0\green0\\blue128;\n".
"\\red0\\green128\\blue128;\\red0\\green128\\blue0;\\red179\\green0\\blue128;\n".
"\\red128\\green0\\blue0;\\red128\\green128\\blue0;\\red128\\green128\\blue128;\n".
"\\red192\\green192\\blue192;\\red255\\green120\\blue0;\\red242\\green243\\blue241;\n".
"}\n";
}
/**
* Loads the fonts table
*
* @return void
*
*/
function load_font_table()
{
$this->MyRTF .= "{\\fonttbl\n".
"{\\f0\\froman\\fcharset0\\fprq2 Times New Roman;}\n".
"{\\f1\\fswiss\\fcharset0\\fprq2 Arial;}\n".
"{\\f2\\fswiss\\fcharset0\\fprq2 Arial Black;}\n".
"{\\f3\\fswiss\\fcharset0\\fprq2 Verdana;}\n".
"{\\f4\\fswiss\\fcharset0\\fprq2 Tahoma;}\n".
"{\\f5\\fmodern\\fcharset0\\fprq2 Courier New;}\n".
"}";
}
/**
* These two function will insert into the document the *CURRENT* time
* and/or the *CURRENT* date. So, it's not the date of the last modify as these
* values will change upon the opening of the generated document.
*
* @return string
*
*/
function cur_date() { return "\\chdate "; }
function cur_time() { return "\\chtime "; }
/**
* Creates a list taking values from an array using bullets.
*
* @arg1 array
* @arg2 keyword (left|center|right|justify)
* @return void|NULL on failure
*
*/
function add_list($array, $align = 'left')
{
if (!is_array($array)) return NULL;
foreach ($array as $k => $v)
{
$this->MyRTF .= "{ ";
$this->bullet($v, $align);
$this->MyRTF .= "} ";
$this->paragraph();
}
}
/**
* Creates a list field using bullets.
*
* @arg1 string
* @arg2 keyword (left|center|right|justify)
* @return void
*
*/
function bullet($text, $align = 'left')
{
$this->TextDecoration .= "\\bullet "; // 2 spaces are needed at the end for spacing the word from the bullet
$this->add_text($text, $align);
}
/**
* Insert some text in the document
*
* @arg1 string
* @arg2 keyword (left|center|right|justify)
* @return void
*
*/
function add_text($msg, $align = 'left')
{
/** FIX RITORNI A CAPO **/
$msg = str_replace("\r", "", $msg);
$msg = str_replace("\n", "", $msg);
/** FIX LETTERE ACCENTATE ** /
$msg = str_replace("à", "\\'e0", $msg);
$msg = str_replace("è", "\\'e8", $msg);
$msg = str_replace("é", "\\'e9", $msg);
$msg = str_replace("ì", "\\'ec", $msg);
$msg = str_replace("ò", "\\'f2", $msg);
$msg = str_replace("ù", "\\'f9", $msg);
*/
$this->align($align);
$this->MyRTF .= "{";
if (empty($this->TextDecoration))
{
$this->TextDecoration .= $this->_font($this->dfl_FontID);
$this->TextDecoration .= $this->_font_size($this->dfl_FontSize);
}
$this->MyRTF .= $this->TextDecoration;
$this->MyRTF .= "{";
$this->MyRTF .= $msg;
$this->MyRTF .= "}} ";
$this->TextDecoration = '';
}
/**
* Insert one or ${times} carriage returns in the document
*
* @arg1 int
* @return void
*
*/
function new_line($times = 1)
{
for ($i=0; $i<$times; $i++)
{ $this->MyRTF .= "\\line\n"; }
}
/**
* Ends the current paragraph (or thought to do so... duh)
*
* @return void
*
*/
function paragraph() { $this->MyRTF .= "\\par\n"; }
/**
* Text formatting functions
*
* bold: grassetto
* italic: corsivo
* underline: sottolineato
* caps: testo in maiuscolo
* emboss: effetto testo in rilievo
* engrave: effetto testo scavato
* outline: effetto testo con contorno
* shadow: effetto testo con ombra
* sub: pedice
* super: apice
*
* @arg1 int (0|1) 1: default
* @return void
*
*/
function bold($s = 1) { return ($s == 0) ? " \\b0 " : "\\b "; }
function italic($s = 1) { return ($s == 0) ? " \\i0 " : "\\i "; }
function underline($s = 1) { return ($s == 0) ? " \\ulnone " : "\\ul "; }
function caps($s = 1) { return ($s == 0) ? " \\caps0 " : "\\caps "; }
function emboss($s = 1) { return ($s == 0) ? " \\embo0 " : "\\embo "; }
function engrave($s = 1) { return ($s == 0) ? " \\impr0 " : "\\impr "; }
function outline($s = 1) { return ($s == 0) ? " \\outl0 " : "\\outl "; }
function shadow($s = 1) { return ($s == 0) ? " \\shad0 " : "\\shad "; }
function sub($s = 1) { return ($s == 0) ? " \\nosupersub " : "\\shad "; }
function super($s = 1) { return ($s == 0) ? " \\nosupersub " : "\\super "; }
/**
* Internal function used to set the font type
* (Not to be used directly. set_font() function as been written for this)
*
* @arg1 int
* @return string
*
*/
function _font($id = 0) { return ("\\f$id "); }
/**
* Internal function used to set the font size (X pt == X*2 pt)
* (Not to be used directly. set_font_size() function as been written for this)
*
* @arg1 int
* @return string
*
*/
function _font_size($size = 20) { return ("\\fs$size "); }
/**
* Sets the default font used in the document ( set_default_font() )
* used when the font is not assigned using set_font() function before
* calling the add_text() function. Same thing for set_default_font_size().
*
* @arg1 string
* @arg2 int
* @return void
*
*/
function set_default_font($font_name, $font_size = 10 )
{
$this->dfl_FontID = $this->get_font_id($font_name);
$this->set_default_font_size($font_size);
}
function set_default_font_size($font_size = 8)
{
$this->dfl_FontSize = ($font_size * 2);
}
/**
* Returns the requested font id (used in RTF syntax)
*
* @arg1 string
* @return int
*
*/
function get_font_id($font_name = NULL)
{
switch ( strtolower($font_name) )
{
case 'times': return(0); break;
case 'arial': return(1); break;
case 'arial black': return(2); break;
case 'verdana': return(3); break;
case 'tahoma': return(4); break;
case 'courier new': return(5); break;
default: return(0); break;
}
}
/**
* Sets the font size only
*
* @arg1 int
* @return void
*
*/
function set_font_size($size)
{
$size *= 2;
$this->TextDecoration .= $this->_font_size($size);
}
/**
* Sets the text font and its size
*
* @arg1 string (font name)
* @arg2 int (font size)
* @return void
*
*/
function set_font($font, $size = 10)
{
$this->FontID = $this->get_font_id($font);
$this->TextDecoration .= $this->_font($this->FontID);
$this->set_font_size($size);
}
/**
* Jump to the next page of the document
*
* @return void
*
*/
function new_page() { $this->MyRTF .= "\\page\n"; }
/**
* Sets the font's color
*
* @return void
*/
function color($ColorID=0) { return "\\cf$ColorID "; }
/**
* Align text and images
* (This is not intended to be used directly)
*
* @arg1 keyword (left|center|right|justify)
*
*/
function align($where = 'left')
{
switch ( strtolower ($where) )
{
case 'left': $this->MyRTF .= "\\ql "; break;
case 'center': $this->MyRTF .= "\\qc "; break;
case 'right': $this->MyRTF .= "\\qr "; break;
case 'justify': $this->MyRTF .= "\\qj "; break;
default: $this->align('left'); break;
}
}
/**
* Insert an image and manages its alignment on the document
* ** TODO ** :: fix bug on image size handling
*
* @arg1 string (image filename)
* @arg2 int (int 1-100)
* @arg3 keyword (left|center|right|justify)
* @return void
*/
function add_image($image, $ratio, $align = 'left', $breakAfter = true)
{
$file = @file_get_contents($image);
if (empty($file))
return NULL;
$this->align($align);
$this->MyRTF .= "{";
$this->MyRTF .= "\\pict\\jpegblip\\picscalex". $ratio ."\\picscaley". $ratio ."\\bliptag132000428 ";
$this->MyRTF .= trim(bin2hex($file));
$this->MyRTF .= "\n}\n";
if($breakAfter)
$this->paragraph();
}
/**
* View/Download of the created RTF files
* NOTE: View feature is for *DEBUG* purposes
*
* @arg1 string
* @return void
*
*/
function display($filename = "document.rtf", $download = true)
{
$this->MyRTF .= "\n}\n}\n";
if ($download == true) // Download
{
header("Content-type: application/msword");
header("Content-Lenght: ". sizeof($this->MyRTF));
header("Content-Disposition: inline; filename=". $filename);
}
print $this->MyRTF;
}
}
?>
