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/Stat.php

Documentation is available at Stat.php

  1. <?PHP
  2. /**
  3.  * Base class for patTemplate Stat
  4.  *
  5.  * $Id: Stat.php 47 2005-09-15 02:55:27Z rhuk $
  6.  *
  7.  * A stat component should be implemented for each reader
  8.  * to support caching. Stats return information about the
  9.  * template source.
  10.  *
  11.  * @package        patTemplate
  12.  * @subpackage    Stat
  13.  * @author        Stephan Schmidt <[email protected]>
  14.  */
  15.  
  16. // Check to ensure this file is within the rest of the framework
  17. defined('JPATH_BASE') or die();
  18.  
  19. /**
  20.  * Base class for patTemplate Stat
  21.  *
  22.  * $Id: Stat.php 47 2005-09-15 02:55:27Z rhuk $
  23.  *
  24.  * A stat component should be implemented for each reader
  25.  * to support caching. Stats return information about the
  26.  * template source.
  27.  *
  28.  * @package        patTemplate
  29.  * @subpackage    Stat
  30.  * @author        Stephan Schmidt <[email protected]>
  31.  * @abstract
  32.  */
  33. class patTemplate_Stat extends patTemplate_Module
  34. {
  35.    /**
  36.     * options, are identical to those of the corresponding reader
  37.     *
  38.     * @access    private
  39.     * @var        array 
  40.     */
  41.     var $_options = array();
  42.  
  43.    /**
  44.     * get the modification time of a template
  45.     *
  46.     * Needed, if a template cache should be used, that auto-expires
  47.     * the cache.
  48.     *
  49.     * @abstract    must be implemented in the template readers
  50.     * @param    mixed    input to read from.
  51.     *                     This can be a string, a filename, a resource or whatever the derived class needs to read from
  52.     * @return    integer    unix timestamp
  53.     */
  54.     function getModificationTime( $input )
  55.     {
  56.         return    -1;
  57.     }
  58.  
  59.    /**
  60.     * set options
  61.     *
  62.     * @access    public
  63.     * @param    array    array containing options
  64.     */
  65.     function setOptions( $options )
  66.     {
  67.         $this->_options        =    $options;
  68.     }
  69. }
  70. ?>
Documentation generated on Mon, 05 Mar 2007 21:26:52 +0000 by phpDocumentor 1.3.1