Source for file Abstract_Page_Controller.php

Documentation is available at Abstract_Page_Controller.php

  1. <?php
  2. /**
  3.  *    LAIKA FRAMEWORK Release Notes:
  4.  *
  5.  *    @filesource     Abstract_Page_Controller.php
  6.  *
  7.  *    @version        0.1.0b
  8.  *    @package        Laika
  9.  *    @subpackage     core
  10.  *    @category       abstract
  11.  *    @date           2012-05-18 21:47:22 -0400 (Fri, 18 May 2012)
  12.  *
  13.  *    @author         Leonard M. Witzel <witzel@post.harvard.edu>
  14.  *    @copyright      Copyright (c) 2012  Laika Soft <{@link http://oafbot.com}>
  15.  *
  16.  */
  17. /**
  18.  * Abstract Laika_Abstract_Page_Controller class.
  19.  * 
  20.  * @abstract
  21.  * @extends Laika_Abstract_Controller
  22.  */
  23. abstract class Laika_Abstract_Page_Controller extends Laika_Abstract_Controller{
  24.     
  25.     const            CACHE_TIME    = 60;
  26.     
  27.     public    static $access_level = 'PUBLIC'; // PUBLIC, PRIVATE, PROTECTED
  28.     public    static $access_group = 'USER';   // USER, ADMIN, WORLD
  29.     public    static $caching      = TRUE;
  30.     protected        $ignore       = array('action_handler');
  31.     
  32. //-------------------------------------------------------------------
  33. //    METHODS
  34. //-------------------------------------------------------------------    
  35.     /**
  36.      * display function.
  37.      * 
  38.      * @access public
  39.      * @return void 
  40.      */
  41.     public function display(){
  42.         $args = func_get_args();
  43.         $view = str_replace('_Controller', '_Page', get_called_class());        
  44.         $this->set_pagination();
  45.  
  46.         if(CACHE_PAGES && $this::$caching):
  47.             $this->caching($args);
  48.         else:
  49.             ob_start(OB_HANDLER);
  50.             $view::init()->render_page($args);          
  51.         endif;
  52.  
  53.         ob_end_flush();
  54.         Laika_Event::dispatch('PAGE_RENDER_COMPLETE',__FILE__);
  55.  
  56.         /*$html = ob_get_contents();
  57.         $html = ob_get_clean();
  58.         $config = array(
  59.            'indent'=> false,
  60.            'hide-comments' => true,
  61.            'output-xhtml' => false,
  62.            'wrap' => false
  63.         );        
  64.         $tidy = new tidy;
  65.         $tidy->parseString($html, $config, 'utf8');
  66.         $tidy->cleanRepair();
  67.         echo tidy_get_output($tidy);
  68.         ob_end_flush();*/
  69.  
  70.     }
  71.  
  72.     /**
  73.      * caching function.
  74.      * 
  75.      * @access public
  76.      * @param mixed $args 
  77.      * @return void 
  78.      */
  79.     public function caching($args){
  80.         $zip = true;
  81.         $view  = str_replace('_Controller', '_Page', get_called_class());
  82.         $class = get_called_class();
  83.         $url   = urlencode( str_replace(HTTP_ROOT, "File_".md5(Laika_User::active()->username), Laika_Router::init()->uri) );
  84.         //$cachefile = SYS_CACHE.basename($class, '.php') . '.cache';
  85.         $cachefile = SYS_CACHE.$url.'.cache';
  86.         clearstatcache();
  87.         
  88.         if (file_exists($cachefile) && filemtime($cachefile) > time() - $this::CACHE_TIME) { // good to serve!
  89.             if($zip)
  90.                 echo gzuncompress(file_get_contents($cachefile));
  91.             else include($cachefile);
  92.             Laika_Event::dispatch('PAGE_RENDER_COMPLETE',__FILE__);
  93.             exit;
  94.         }        
  95.  
  96.         ob_start();
  97.         $view::init()->render_page($args);        
  98.  
  99.         $contents = ob_get_contents();
  100.         ob_end_clean();
  101.         $handle = fopen($cachefile, "w");
  102.         fwrite($handle, gzcompress($contents));
  103.         fclose($handle);
  104.         
  105.         if($zip) echo gzuncompress(file_get_contents($cachefile));
  106.         else include($cachefile);
  107.         Laika_Event::dispatch('PAGE_RENDER_COMPLETE',__FILE__);        
  108.     }
  109.        
  110.     /**
  111.      * action_handler function.
  112.      * 
  113.      * Check if method exists. If called method does not exist or action_handler
  114.      * is called recursively, direct flow of control to the default_action.
  115.      * Otherwise perform requested action.
  116.      *
  117.      * @access public
  118.      * @param mixed $action 
  119.      * @param mixed $parameters 
  120.      * @return void 
  121.      */
  122.     public function action_handler($action,$parameters){
  123.         $this->ignore = array_merge($this->ignore, get_class_methods(get_parent_class(get_parent_class($this))));
  124.         
  125.         !empty($parameters) ? $this->parameters = $parameters : $this->parameters = NULL;        
  126.         if( $action == 'default' )
  127.             $this->default_action();
  128.         else if( !method_exists(get_called_class(), $action) | in_array($action,$this->ignore)) 
  129.             $this->default_action();
  130.         else $this->$action();    
  131.     }
  132.         
  133.     /**
  134.      * default_action function.
  135.      * 
  136.      * @access public
  137.      * @return void 
  138.      */
  139.     abstract protected function default_action();
  140.  
  141.     
  142.     /**
  143.      * set_pagination function.
  144.      * 
  145.      * @access public
  146.      * @return void 
  147.      */
  148.     public function set_pagination(){
  149.         if(!isset($this->parameters['p']))
  150.             $_SESSION['pagination'] = 1;
  151.         else
  152.             $_SESSION['pagination'] = $this->parameters['p'];
  153.     }
  154.     
  155.     /**
  156.      * alert function.
  157.      * 
  158.      * @access public
  159.      * @return void 
  160.      */
  161.     public function alert(){        
  162.         $view = str_replace('_Controller', '_Page', get_called_class());
  163.         $view::init()->alert_type = $this->parameters['type'];
  164.         $view::init()->alert = $this->parameters['message'];
  165.         $view::render_alert();    
  166.     }
  167. }

Documentation generated on Sat, 19 May 2012 02:16:54 -0400 by phpDocumentor 1.4.4