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
 132     /**
 133     * Arguments from cli if static $cli_opts is used.
 134     *
 135     * @var array
 136     * @access public
 137     */
 138     var $cli_args = array(); // key(element name)=>error message
 139
 140
 141
 142
 143
 144
 145
 146     /**
 147     * The default page handler
 148     * by default relays to get(), or post() methods depending on the request.
 149     *
 150     * Override this if you do not handle get or post differently.
 151     *
 152     *
 153     * @param   string  request, the remainder of the request not handled by the object.
 154     *
 155     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 156     * @access   public
 157     */
 158
 159     function start($request,$isRedirect=false,$args=array())
 160     {
 161         $cli= HTML_Flexyframework::get()->cli;
 162         if (!$cli && !$isRedirect && !empty($_SERVER["REQUEST_METHOD"]) && $_SERVER["REQUEST_METHOD"] == "POST") {
 163             return $this->post($request,$args);
 164         } else {
 165             return $this->get($request,$args,$isRedirect);
 166         }
 167     }
 168     /**
 169     * The get page handler
 170     *
 171     * Override this if you want to handle get requests
 172     *
 173     *
 174     * @param   string  request, the remainder of the request not handled by the object.
 175     *
 176     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 177     * @access   public
 178     */
 179     function get($request)
 180     {
 181     }
 182      /**
 183     * The post page handler
 184     *
 185     * Override this if you want to handle get requests
 186     *
 187     *
 188     * @param   string  request, the remainder of the request not handled by the object.
 189     *
 190     * @return   none|string none = handled, string = redirect to another page = eg. data/list
 191     * @access   public
 192     */
 193    function post($request)
 194    {
 195    }
 196     /**
 197     * Authentication Check method
 198     * Override this with a straight return for pages that do not require authentication
 199     *
 200     * By default
 201     *   a) redirects to login if authenticaiton fails
 202     *   b) checks to see if a isAdmin method exists on the auth object
 203     *       if it does see if the user is admin and let them in.
 204     *       otherwise access denied error is raised
 205     *   c) lets them in.
 206     *
 207     *
 208     *
 209     * @return   none or string redirection to another page.
 210     * @access   public
 211     */
 212
 213     function getAuth() {
 214
 215
 216         return false;
 217
 218     }
 219
 220
 221
 222
 223     /**
 224     * The master Output layer.
 225     *
 226     * compiles the template
 227     * if no caching - just runs the template.
 228     * otherwise stores it in the cache.
 229     *
 230     * you dont normally need to override this.
 231     *
 232     * called by the page loader.
 233     * @access   public
 234     */
 235
 236
 237
 238     function output()
 239     {
 240         /* output the body if no masterTemplate is set */
 241         $options = PEAR::getStaticProperty('HTML_FlexyFramework','options');
 242
 243         $type = isset($this->contentType) ? $this->contentType : 'text/html';
 244         header('Content-Type: '.$type.';charset='.( empty($options['charset']) ? 'UTF-8' : $options['charset'] ));
 245
 246
 247         if (!$this->masterTemplate) {
 248             return $this->outputBody();
 249         }
 250         /* master template */
 251
 252
 253         $template_engine = new HTML_Template_Flexy();
 254         $template_engine->compile($this->masterTemplate);
 255         if (!$this->_cache || !$this->cacheMethod) {\r
 256             $template_engine->outputObject($this,$this->elements);
 257             return;
 258         }
 259
 260         $id = $this->_cache->generateID($this->getID());
 261         $this->_cache->save($id, $template_engine->bufferedOutputObject($this,$this->elements));
 262         echo $this->_cache->get($id);
 263
 264     }
 265     /**
 266     * The body Output layer.
 267     *
 268     * compiles the template
 269     * At present there is no caching in here..  - this may change latter..
 270     *
 271     * used by putting {outputBody} in the main template.
 272     * @access   public
 273     */
 274     function outputBody() {
 275
 276         $template_engine = new HTML_Template_Flexy();
 277         $template_engine->compile($this->template);
 278         if ($this->elements) { /* BC crap! */
 279             $this->elements = HTML_Template_Flexy_Factory::setErrors($this->elements,$this->errors);
 280         }
 281         $template_engine->elements = $this->elements;
 282         $template_engine->outputObject($this,$this->elements);
 283
 284     }
 285
 286
 287      /**
 288     * Do any Page Caching if $this->cacheMethod is set.
 289     * You should also look at output caching by overriding the outputBody Method.
 290     *
 291     * Note that Caching is disabled in a number of situations.
 292     *   a) cacheMethod is empty
 293     *   b) POST requests
 294     *   c) if sess is set (Eg. if you are using sessions)
 295     *   d) useCache is not set in the [Cache] section of the config.
 296     *
 297     * utilizes $this->getCacheID() to
 298     *
 299     * @return   none|boolean|string|int|object    Description
 300     * @access   public|private
 301     * @see      see also methods.....
 302     */
 303
 304
 305     function getCache() {
 306         if (!$this->cacheMethod) {
 307             return;
 308         }
 309         if ($_SERVER["REQUEST_METHOD"] == "POST") {
 310             return;
 311         }
 312
 313         /* lets assume we can cache ourselves.. */
 314         $coptions = PEAR::getStaticProperty('Cache','options');
 315         if (!$coptions) {
 316             return;
 317         }
 318         if (empty($coptions['useCache'])) {
 319             return;
 320         }
 321         require_once 'Cache.php';
 322
 323         $this->_cache = new Cache($coptions['container'], $coptions);
 324         $id = $this->_cache->generateID($this->getCacheID());
 325         if ($_SERVER["REQUEST_METHOD"] == "POST") {
 326             $this->_cache->flush($id);
 327             return;
 328         }
 329         if ($data = $this->_cache->get($id)) {
 330             echo $data;
 331             return TRUE;
 332         }
 333
 334     }
 335
 336     /**
 337     * Get a distinct Page Cache ID.
 338     *
 339     * By default this is the full request string
 340     * override this to define a more precise string
 341     *
 342     * @return   string   distinct page id (eg. the request url)
 343     * @access   private
 344     */
 345
 346     function getCacheID() {
 347         return  $this->request;
 348
 349     }
 350
 351
 352     /**
 353     * Utility method : get the Class name (used on templates)
 354     *
 355     * @return   string   class name
 356     * @access   public
 357     */
 358
 359
 360     function getClass() {
 361         return get_class($this);
 362     }
 363     /**
 364     * Utility method : get the Time taken to generate the page.
 365     *
 366     * @return   string   time in seconds..
 367     * @access   public
 368     */
 369
 370     function getTime() {
 371
 372         $m = explode(' ',microtime());
 373         $ff =  HTML_FlexyFramework::get();
 374         return sprintf('%0.2fs',($m[0] + $m[1]) -  $ff->start)
 375                 . '/ Files ' . count(get_included_files());
 376
 377
 378     }
 379
 380 }
 381
 382