File Source for Xml2Pdf.php

<?php
/**
* Xml2Pdf.
*
* @filesource
*
* @author guillaume l. <guillaume@geelweb.org>
* @link http://www.geelweb.org
* @license http://opensource.org/licenses/bsd-license.php BSD License
* @copyright copytight © 2006, guillaume luchet
* @package Xml2Pdf
* @version 0.6.10.9
*
* @todo bench : recursion
* @todo add tag <include file="include_file.xml" />
*/
// dependances {{{
/**
* include config file.
*/
require_once('Xml2Pdf.config.php');
/**
* include the class Pdf.
*/
require_once('Pdf.php');
// }}}
/**
* Parse an XML file and convert it on PDF document.
*
* Parse an XML content using the
* {@link http://php.net/manual/en/ref.xml.php PHP XML parser functions}
* then convert it on PDF document using
* {@link http://www.fpdf.org FPDF}.
*
* For each tag XML, the parser try to instantiate the corresponding object
* searching it in the tag plugin directory. eg, to a tag named custom, it'll
* search the file <b>xml2pdf.tag.custom.php</b>, then it'll instantiate the
* class <b>Xml2PdfTag_custom</b>.
*
* The tag plugins class must have the following method :
* - void __construtc(object Pdf, array) or void __construct(object Pdf, array, object Pdf)
* - void addContent(string)
* - void close()
*
* Example of plugin class :
* <code>
* class Xml2PdfTag_custom {
* /**
* * objet représentant la balise mère.
* {@*}
* public $parent;
*
* /**
* * objet Pdf.
* {@*}
* public $pdf;
*
* /**
* * contenu de la balise.
* {@*}
* public $content;
*
* /**
* * Constructeur :
* *
* * il peut prendre seulement deux paramètres, dans ce cas, la balise mère
* * ne sera pas connu.
* {@*}
* public function __construct($pdf, $tagProperties, $parent) {
* // here you can parse the tagProperties
* }
*
* /**
* * ajoute le contenu.
* {@*}
* public function addContent($content) {
* // ici vous pouvez gérer les actions à effectué sur le contenu de
* // la balise
* }
*
* /**
* * méthode appelé quand la balise est fermée.
* {@*}
* public function close() {
* // ici vous pouvez mettre l'action à effectué quand la balise
* // à été analysé
* }
* }
* </code>
*
* To simplify the plugin class code, you can extends your plugin class with
* {@link Xml2PdfTag Xml2PdfTag} or {@link Xml2PdfTextTag Xml2PdfTextTag}.
*
* @author guillaume l. <guillaume@geelweb.org>
* @link http://www.geelweb.org
* @license http://opensource.org/licenses/bsd-license.php BSD License
* @copyright copyright © 2006, guillaume luchet
* @package Xml2Pdf
* @tutorial Xml2Pdf/Xml2Pdf.pkg
* @version 0.6.10.8
*/
Class Xml2Pdf {
// class properties {{{
/**
* XML content.
* @var string
*/
private $_xml = null;
/**
* object Pdf.
* @var object Pdf
*/
private $_pdf = null;
/**
* tags stack.
* @var array
*/
private $_tagStack = array();
/**
* True if the tag does not be parsed.
* @var boolean
*/
private $_donotparse = false;
// }}}
// Xml2Pdf::__construct() {{{
/**
* Constructor.
*
* @param string $xml xml file or content
* @return void
*/
public function __construct($xml) {
set_exception_handler(array('Xml2Pdf', 'showException'));
$this->_xml = $this->_getXmlContent($xml);
$this->_pdf = new Pdf();
}
// }}}
// Xml2Pdf::render() {{{
/**
* Build the document.
*
* Parse the XML content, build the PDF document then return it.
*
* @return object Pdf
*/
public function render() {
$this->_parse();
return $this->_pdf;
}
// }}}
// Xml2Pdf::_parse() {{{
/**
* Parse the XML content.
*
* Parse the XML content using PHP XML parser functions.
*
* @return boolean
*/
private function _parse() {
$xml_parser = xml_parser_create(XML_ENCODING);
xml_set_object ($xml_parser, $this);
xml_set_character_data_handler ($xml_parser, '_parseContent');
xml_set_element_handler($xml_parser, '_parseOpeningTag', '_parseClosingTag');
if(!xml_parse ($xml_parser, $this->_xml)) {
throw new Exception(sprintf('xml error %s at line %d',
xml_error_string(xml_get_error_code($xml_parser)),
xml_get_current_line_number($xml_parser)));
}
xml_parser_free($xml_parser);
return true;
}
// }}}
// Xml2Pdf::_parseOpeningTag() {{{
/**
* Parse the opening tag.
*
* Try to instantitate the tag plugin class.
*
* @param object $parser parser xml
* @param string $tag tag name
* @param array $tagProperties tag properties
* @return void
*/
private function _parseOpeningTag($parser, $tag, $tagProperties) {
if(isset($this->_pdf->styles[$tag])) {
$this->_parseContent($parser, '<'.$tag.'>');
return;
}
if($this->_donotparse) {
$tagToText = '<' . strtolower($tag);
foreach ($tagProperties as $key=>$value) {
$tagToText .= ' ' . strtolower($key) . '="' . $value . '"';
}
$tagToText .= '/>';
$this->_parseContent($parser, $tagToText);
return;
}
$tagName = strtolower($tag);
$pluginFileName = 'xml2pdf.tag.' . $tagName . '.php';
$pluginFilePath = XML2PDF_PLUGINS_TAGS_PATH . '/' . $pluginFileName;
$pluginClass = 'Xml2PdfTag_' . $tagName;
if(file_exists($pluginFilePath)) {
require_once($pluginFileName);
if(!class_exists($pluginClass)) {
throw new Exception(
sprintf('Xml2Pdf error : unknow plugin class %s for tag %s',
$pluginClass, $tagName));
die();
}
try {
$parent = array_pop($this->_tagStack);
array_push($this->_tagStack, $parent);
$this->_tagStack[] = new $pluginClass($this->_pdf, $tagProperties, $parent);
if($tag == 'LITERAL') {
$this->_donotparse = true;
}
} catch(Exception $e) {
$this->_tagStack[] = new $pluginClass($this->_pdf, $tagProperties);
}
} else {
throw new Exception(sprintf('Xml2Pdf parsing error : unknow plugin file %s for tag %s',
$pluginFileName, $tagName));
die();
}
}
// }}}
// Xml2Pdf::_parseClosingTag(object, string) {{{
/**
* Parse closing tags.
*
* Call the method close() of the last tag of the tags stack.
*
* @param object $parser xml parser.
* @param string $tag tag name.
* @return void
*/
private function _parseClosingTag($parser, $tag) {
if(isset($this->_pdf->styles[$tag])) {
$this->_parseContent($parser, '</'.$tag.'>');
return;
}
if($tag == 'LITERAL') {
$this->_donotparse = false;
}
if ($this->_donotparse) {
$this->_parseContent($parser, '</'.strtolower($tag).'>');
return;
}
$tagObject = array_pop($this->_tagStack);
$result = $tagObject->close();
}
// }}}
// Xml2Pdf::_parseContent(object, content) {{{
/**
* Parse the tag content.
*
* Call the method addContent() of the last tag of the tags stack.
*
* @param object $parser analyseur xml
* @param string $content contenue
* @return void
*/
private function _parseContent($parser, $content) {
$tagObject = array_pop($this->_tagStack);
$tagObject->addContent($content);
array_push($this->_tagStack, $tagObject);
}
// }}}
// Xml2Pdf::showException() {{{
/**
* Show an error message.
*
* It's also the exception handler.
*
* @param object $exception objet Exception
* @return void
*/
static function showException($exception) {
throw $exception;
echo '<pre>';
print_r('Xml2Pdf error : ' . $exception->getMessage());
echo '</pre>';
}
// }}}
// Xml2Pdf::_getXmlContent(string) {{{
/**
* Get the xml content of a file.
*
* @return string
*/
private function _getXmlContent($xml) {
if(file_exists($xml)) {
$xml = implode('', file($xml));
} else if(is_string($xml)) {
$xml = $xml;
}
return $xml;
}
// }}}
// Xml2Pdf::convertColor(string) {{{
/**
* Convert an hexadecimal color on RGB color.
*
* @param string $color coulor.
* @return array
*/
static function convertColor($color) {
if(is_array($color)) {
return $color;
}
$array = array();
$array['r'] = substr((string)$color,1,2);
$array['g'] = substr((string)$color,3,2);
$array['b'] = substr((string)$color,5,2);
$array['r'] = hexdec($array['r']);
$array['g'] = hexdec($array['g']);
$array['b'] = hexdec($array['b']);
return $array;
}
// }}}
// Xml2Pdf::getColor() // {{{
/**
* Generate a RGB color.
*
* @return array
* @access public
*/
static function getColor() {
$array = array();
$array['r'] = rand(128, 255);
$array['g'] = rand(128, 255);
$array['b'] = rand(128, 255);
return $array;
}
// }}}
}
?>

Documentation generated on Wed, 11 Oct 2006 22:27:17 +0200 by phpDocumentor 1.3.0

Source for file Xml2Pdf.php