Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: patTemplate

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /pattemplate/patTemplate/Function.php

Documentation is available at Function.php

  1. <?PHP
  2. /**
  3.  * Base class for patTemplate functions
  4.  *
  5.  * $Id: Function.php 311 2004-10-27 13:52:20Z schst $
  6.  *
  7.  * @package        patTemplate
  8.  * @subpackage    Functions
  9.  * @author        Stephan Schmidt <[email protected]>
  10.  */
  11.  
  12. // Check to ensure this file is within the rest of the framework
  13. defined('JPATH_BASE') or die();
  14.  
  15. /**
  16.  * function is executed, when template is compiled (preg_match)
  17.  */
  18. define('PATTEMPLATE_FUNCTION_COMPILE', 1);
  19.  
  20. /**
  21.  * function is executed, when template parsed
  22.  */
  23. define('PATTEMPLATE_FUNCTION_RUNTIME', 2);
  24.  
  25. /**
  26.  * Base class for patTemplate functions
  27.  *
  28.  * $Id: Function.php 311 2004-10-27 13:52:20Z schst $
  29.  *
  30.  * @abstract
  31.  * @package        patTemplate
  32.  * @subpackage    Functions
  33.  * @author        Stephan Schmidt <[email protected]>
  34.  */
  35. class patTemplate_Function extends patTemplate_Module
  36. {
  37.    /**
  38.     * reader object
  39.     *
  40.     * @access private
  41.     * @var      object 
  42.     */
  43.     var $_reader;
  44.  
  45.    /**
  46.     * function type
  47.     *
  48.     * @access public
  49.     * @var      integer 
  50.     */
  51.     var $type = PATTEMPLATE_FUNCTION_COMPILE;
  52.  
  53.    /**
  54.     * set the reference to the reader object
  55.     *
  56.     * @access    public
  57.     * @param    object patTemplate_Reader 
  58.     */
  59.     function setReader( &$reader )
  60.     {
  61.         $this->_reader = &$reader;
  62.     }
  63.  
  64.    /**
  65.     * call the function
  66.     *
  67.     * @abstract
  68.     * @access    public
  69.     * @param    array    parameters of the function (= attributes of the tag)
  70.     * @param    string    content of the tag
  71.     * @return    string    content to insert into the template
  72.     */
  73.     function call( $params, $content )
  74.     {
  75.     }
  76. }
  77. ?>
Documentation generated on Mon, 05 Mar 2007 21:02:16 +0000 by phpDocumentor 1.3.1