git.roojs.org Git - pear/blob - HTML/FlexyFramework/Page.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4: */
   3 // +----------------------------------------------------------------------+
   4 // | PHP Version 4                                                        |
   5 // +----------------------------------------------------------------------+
   6 // | Copyright (c) 1997-2002 The PHP Group                                |
   7 // +----------------------------------------------------------------------+
   8 // | This source file is subject to version 2.02 of the PHP license,      |
   9 // | that is bundled with this package in the file LICENSE, and is        |
  10 // | available at through the world-wide-web at                           |
  11 // | http://www.php.net/license/2_02.txt.                                 |
  12 // | If you did not receive a copy of the PHP license and are unable to   |
  13 // | obtain it through the world-wide-web, please send a note to          |
  14 // | license@php.net so we can mail you a copy immediately.               |
  15 // +----------------------------------------------------------------------+
  16 // | Authors:  Alan Knowles <alan@akbkhome.com>                           |
  17 // +----------------------------------------------------------------------+
  18 //
  19 // $Id: Page.php,v 1.5 2003/02/22 01:52:50 alan Exp $
  20 //
  21 // A Base Page Class for use with HTML_Template_Flexy
  22 // You could write one of these which used another template engine.
  23 //
  24
  25
  26 require_once 'HTML/Template/Flexy.php' ;
  27 require_once 'HTML/Template/Flexy/Factory.php' ;
  28
  29 /**
  30 * The Base Page class - extend and override the methods to implement your own pages.
  31 *
  32 *
  33 */
  34
  35 class HTML_FlexyFramework_Page  {
  36
  37
  38     /**
  39     * the main Template name (which can include a body template)
  40     *
  41     * @var string template name
  42     * @access public
  43     */
  44     var $masterTemplate = "master.html";
  45     /**
  46     * the body Template name
  47     *
  48     * @var string template name
  49     * @access public
  50     */
  51     var $template = "error.html";
  52
  53
  54
  55
  56     /**
  57     * cache method -
  58     *   can be 'output', or 'data'
  59     * used to set a default caching method
  60     *
  61     * @var string
  62     * @access public
  63     * @see getCache()
  64     */
  65     var $cacheMethod = '';
  66
  67
  68
  69
  70    /**
  71     * cache store (PEAR's Cache Object Instance
  72     *   initialized at start
  73     *   set at output stage.
  74     *
  75     * @var object
  76     * @access private
  77     * @see getCache()
  78     */
  79
  80     var $_cache = NULL;
  81
  82     /* ---- Variables set by Page loader -------- */
  83
  84
  85
  86     /**
  87     * baseURL, that can be prefixed to URL's to ensure that they correctly relate to application
  88     * (set by page loader)
  89     * @var string
  90     * @access public
  91     */
  92     var $baseURL;
  93     /**
  94     * rootURL, the base installation directory - can be used to get images directories.
  95     * (set by page loader)
  96     * @var string
  97     * @access public
  98     */
  99     var $rootURL;
 100     /**
 101     * rootDir, the base installation directory - can be used to find relative files.
 102     * (set by page loader)
 103     * @var string
 104     * @access public
 105     */
 106     var $rootDir;
 107     /**
 108     * the full request string used by the getCacheID().
 109     * (set by page loader)
 110     * @var string
 111     * @access public
 112     */
 113     var $request; // clean page request for page
 114     /**
 115     * overrides for elements.
 116     *
 117     * @var array
 118     * @access public
 119     */
 120     var $elements = array(); // key=>HTML_Template_Flexy_Element
 121
 122      /**
 123     * errors for elements
 124     *
 125     * @var array
 126     * @access public
 127     */
 128     var $errors = array(); // key(element name)=>error message
 129
 130     /**
 131     * The default page handler
 132     * by default relays to get(), or post() methods depending on the request.
 133     *
 134     * Override this if you do not handle get or post differently.
 135     *
 136     *
 137     * @param   string  request, the remainder of the request not handled by the object.
 138     *
 139     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 140     * @access   public
 141     */
 142
 143     function start($request,$isRedirect=false,$args=array())
 144     {
 145         $cli= HTML_Flexyframework::get()->cli;
 146         if (!$cli && !$isRedirect && !empty($_SERVER["REQUEST_METHOD"]) && $_SERVER["REQUEST_METHOD"] == "POST") {
 147             return $this->post($request,$args);
 148         } else {
 149             return $this->get($request,$args,$isRedirect);
 150         }
 151     }
 152     /**
 153     * The get page handler
 154     *
 155     * Override this if you want to handle get requests
 156     *
 157     *
 158     * @param   string  request, the remainder of the request not handled by the object.
 159     *
 160     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 161     * @access   public
 162     */
 163     function get($request)
 164     {
 165     }
 166      /**
 167     * The post page handler
 168     *
 169     * Override this if you want to handle get requests
 170     *
 171     *
 172     * @param   string  request, the remainder of the request not handled by the object.
 173     *
 174     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 175     * @access   public
 176     */
 177    function post($request)
 178    {
 179    }
 180     /**
 181     * Authentication Check method
 182     * Override this with a straight return for pages that do not require authentication
 183     *
 184     * By default
 185     *   a) redirects to login if authenticaiton fails
 186     *   b) checks to see if a isAdmin method exists on the auth object
 187     *       if it does see if the user is admin and let them in.
 188     *       otherwise access denied error is raised
 189     *   c) lets them in.
 190     *
 191     *
 192     *
 193     * @return   none or string redirection to another page.
 194     * @access   public
 195     */
 196
 197     function getAuth() {
 198
 199
 200         return false;
 201
 202     }
 203
 204
 205
 206
 207     /**
 208     * The master Output layer.
 209     *
 210     * compiles the template
 211     * if no caching - just runs the template.
 212     * otherwise stores it in the cache.
 213     *
 214     * you dont normally need to override this.
 215     *
 216     * called by the page loader.
 217     * @access   public
 218     */
 219
 220
 221
 222     function output()
 223     {
 224         /* output the body if no masterTemplate is set */
 225         $options = PEAR::getStaticProperty('HTML_FlexyFramework','options');
 226
 227         $type = isset($this->contentType) ? $this->contentType : 'text/html';
 228         header('Content-Type: '.$type.';charset='.( empty($options['charset']) ? 'UTF-8' : $options['charset'] ));
 229
 230
 231         if (!$this->masterTemplate) {
 232             return $this->outputBody();
 233         }
 234         /* master template */
 235
 236
 237         $template_engine = new HTML_Template_Flexy();
 238         $template_engine->compile($this->masterTemplate);
 239         if (!$this->_cache || !$this->cacheMethod) {\r
 240             $template_engine->outputObject($this,$this->elements);
 241             return;
 242         }
 243
 244         $id = $this->_cache->generateID($this->getID());
 245         $this->_cache->save($id, $template_engine->bufferedOutputObject($this,$this->elements));
 246         echo $this->_cache->get($id);
 247
 248     }
 249     /**
 250     * The body Output layer.
 251     *
 252     * compiles the template
 253     * At present there is no caching in here..  - this may change latter..
 254     *
 255     * used by putting {outputBody} in the main template.
 256     * @access   public
 257     */
 258     function outputBody() {
 259
 260         $template_engine = new HTML_Template_Flexy();
 261         $template_engine->compile($this->template);
 262         if ($this->elements) { /* BC crap! */
 263             $this->elements = HTML_Template_Flexy_Factory::setErrors($this->elements,$this->errors);
 264         }
 265         $template_engine->elements = $this->elements;
 266         $template_engine->outputObject($this,$this->elements);
 267
 268     }
 269
 270
 271      /**
 272     * Do any Page Caching if $this->cacheMethod is set.
 273     * You should also look at output caching by overriding the outputBody Method.
 274     *
 275     * Note that Caching is disabled in a number of situations.
 276     *   a) cacheMethod is empty
 277     *   b) POST requests
 278     *   c) if sess is set (Eg. if you are using sessions)
 279     *   d) useCache is not set in the [Cache] section of the config.
 280     *
 281     * utilizes $this->getCacheID() to
 282     *
 283     * @return   none|boolean|string|int|object    Description
 284     * @access   public|private
 285     * @see      see also methods.....
 286     */
 287
 288
 289     function getCache() {
 290         if (!$this->cacheMethod) {
 291             return;
 292         }
 293         if ($_SERVER["REQUEST_METHOD"] == "POST") {
 294             return;
 295         }
 296
 297         /* lets assume we can cache ourselves.. */
 298         $coptions = PEAR::getStaticProperty('Cache','options');
 299         if (!$coptions) {
 300             return;
 301         }
 302         if (empty($coptions['useCache'])) {
 303             return;
 304         }
 305         require_once 'Cache.php';
 306
 307         $this->_cache = new Cache($coptions['container'], $coptions);
 308         $id = $this->_cache->generateID($this->getCacheID());
 309         if ($_SERVER["REQUEST_METHOD"] == "POST") {
 310             $this->_cache->flush($id);
 311             return;
 312         }
 313         if ($data = $this->_cache->get($id)) {
 314             echo $data;
 315             return TRUE;
 316         }
 317
 318     }
 319
 320     /**
 321     * Get a distinct Page Cache ID.
 322     *
 323     * By default this is the full request string
 324     * override this to define a more precise string
 325     *
 326     * @return   string   distinct page id (eg. the request url)
 327     * @access   private
 328     */
 329
 330     function getCacheID() {
 331         return  $this->request;
 332
 333     }
 334
 335
 336     /**
 337     * Utility method : get the Class name (used on templates)
 338     *
 339     * @return   string   class name
 340     * @access   public
 341     */
 342
 343
 344     function getClass() {
 345         return get_class($this);
 346     }
 347     /**
 348     * Utility method : get the Time taken to generate the page.
 349     *
 350     * @return   string   time in seconds..
 351     * @access   public
 352     */
 353
 354     function getTime() {
 355
 356         $m = explode(' ',microtime());
 357         $ff =  HTML_FlexyFramework::get();
 358         return sprintf('%0.2fs',($m[0] + $m[1]) -  $ff->start)
 359                 . '/ Files ' . count(get_included_files());
 360
 361
 362     }
 363
 364 }
 365
 366