phpDocumentor ZNF
Presentation
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]
ZNF
Packages:
ZNF

Source for file XSLT.php

Documentation is available at XSLT.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4.  * PHP version 5
  5.  *
  6.  * This source file is subject to version 2.1 of the GNU Lesser General Public
  7.  * License, that is bundled with this package in the file COPYING, available
  8.  * through the world wide web at the following URI:
  9.  * http://www.gnu.org/copyleft/lesser.html.
  10.  *
  11.  * @package    ZNF
  12.  * @subpackage Presentation
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @copyright  2004-2007 The ZNF Development Team
  16.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  17.  * @version    SVN $Id: XSLT.php 43 2007-06-26 23:36:35Z aronnax $
  18.  * @since      Release 0.5.0
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. require_once('ZNF/Presentation/Render.php');
  23.  
  24. /**
  25.  * <i>ZNF_Presentation_XSLT</i> class, extends the <i>ZNF_Presentation_Render</i> class and implements renderization with PHP <i>XSLTProcessor</i>.
  26.  *
  27.  * Render XML data using package or theme XSLT.
  28.  *
  29.  * @access     public
  30.  * @package    ZNF
  31.  * @subpackage Presentation
  32.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  33.  * @author     Graziano Liberati <http://www.liberati.org>
  34.  * @copyright  2004-2007 The ZNF Development Team
  35.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  36.  * @version    SVN $Id: XSLT.php 43 2007-06-26 23:36:35Z aronnax $
  37.  * @since      Release 0.5.0
  38.  * @link       http://www.zeronotice.org
  39.  */
  40. class ZNF_Presentation_XSLT extends ZNF_Presentation_Render
  41. {
  42.  
  43.     /**
  44.      * The <i>XSLTProcessor</i>.
  45.      *
  46.      * @access protected
  47.      * @var XSLTProcessor $_xslt 
  48.      */
  49.      protected $_xslt;
  50.  
  51.     /**
  52.      * Where assigned XSLT parameters are kept.
  53.      *
  54.      * @access protected
  55.      * @var array $_xsltParams 
  56.      */
  57.      protected $_xsltParams = array();
  58.  
  59.     /**
  60.      * Constructs a new <i>ZNF_Presentation_XSLT</i> object and sets the internal properties with application settings.
  61.      *
  62.      * @access public
  63.      * @param string $package Name of the package to which the xslt template
  64.      *                         refers, leave null this parameter to refer to the
  65.      *                         theme xslt template
  66.      * @param ZNF_Action_ActionMapping $mapping 
  67.      */
  68.     public function __construct($package = null, $mapping = null)
  69.     {
  70.         parent::__construct($package, $mapping);
  71.  
  72.         $this->_xslt = new XSLTProcessor();
  73.     }
  74.  
  75.     /**
  76.      * Executes and returns the xslt template results.
  77.      *
  78.      * @access public
  79.      * @param string $template File name of the xslt template
  80.      * @param string $xml The XML document
  81.      * @return string 
  82.      */
  83.     public function fetch($template, $xml = null)
  84.     {
  85.         $template = $this->_getTemplatePath($template);
  86.  
  87.         $this->_xslt->importStylesheet(DOMDocument::load($template));
  88.         $this->_assignConstants($template);
  89.  
  90.         // change this istruction when the xsltprocessor->setParameter() is fixed to accept an array
  91.         foreach ($this->_xsltParams as $name => $value) {
  92.             $this->_xslt->setParameter('znf', $name, $value);
  93.         }
  94.  
  95.         return $this->_xslt->transformToXml(DOMDocument::loadXML($xml));
  96.     }
  97.  
  98.     /**
  99.      * Executes and displays the xslt template results.
  100.      *
  101.      * @access public
  102.      * @param string $template File name of the xslt template
  103.      * @param string $xml The XML document
  104.      */
  105.     public function display($template, $xml = null)
  106.     {
  107.         $template = $this->_getTemplatePath($template);
  108.  
  109.         $this->_xslt->importStylesheet(DOMDocument::load($template));
  110.         $this->_assignConstants($template);
  111.  
  112.         // change this istruction when the xsltprocessor->setParameter() is fixed to accept an array
  113.         foreach ($this->_xsltParams as $name => $value) {
  114.             $this->_xslt->setParameter('znf', $name, $value);
  115.         }
  116.  
  117.         echo $this->_xslt->transformToXml(DOMDocument::loadXML($xml));
  118.     }
  119.  
  120.     /**
  121.      * Assigns values to xslt template parameters.
  122.      *
  123.      * @access public
  124.      * @param string $param The xslt template parameter name
  125.      * @param mixed $value The value to assign
  126.      */
  127.     public function assign($param, $value)
  128.     {
  129.         if ($param) {
  130.             $this->_xsltParams[$param] = $value;
  131.         }
  132.     }
  133.  
  134.     /**
  135.      * Assign to xslt template the ZNF constants.
  136.      *
  137.      * @access protected
  138.      */
  139.     protected function _assignConstants()
  140.     {
  141.         $constants = $this->_getConstants();
  142.  
  143.         $this->assign('znf.baseHref', $constants['baseHref']);
  144.         $this->assign('znf.actionIndex', $constants['actionIndex']);
  145.         $this->assign('znf.moduleIndex', $constants['moduleIndex']);
  146.         $this->assign('znf.themePath', $constants['themePath']);
  147.         $this->assign('znf.packagePath', $constants['packagePath']);
  148.         $this->assign('znf.path', $constants['path']);
  149.         $this->assign('znf.nextPath', $constants['nextPath']);
  150.         $this->assign('znf.credits', $constants['credits']);
  151.     }
  152.  
  153.     /**
  154.      * Destroys the <i>ZNF_Presentation_XSLT</i> object.</>
  155.      *
  156.      * @access public
  157.      */
  158.     public function __destruct()
  159.     {
  160.     }
  161.  
  162. }
  163.  
  164. /**
  165.  * <i>ZNF_Presentation_XSLTException</i> is the exception type for the <i>ZNF_Presentation_XSLT</i> class.
  166.  *
  167.  * <i>ZNF_Presentation_XSLTException</i> extends the <i>Exception</i> class of PHP5.
  168.  *
  169.  * @access     public
  170.  * @package    ZNF
  171.  * @subpackage Presentation
  172.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  173.  * @author     Graziano Liberati <http://www.liberati.org>
  174.  * @copyright  2004-2007 The ZNF Development Team
  175.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  176.  * @version    SVN $Id: XSLT.php 43 2007-06-26 23:36:35Z aronnax $
  177.  * @since      Release 0.5.0
  178.  * @link       http://www.zeronotice.org
  179.  */
  180. class ZNF_Presentation_XSLTException extends Exception
  181. {
  182. }
  183.  
  184. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:43 +0100 by phpDocumentor 1.4.0