Source for file ViewPlugin.php

Documentation is available at ViewPlugin.php

  1. <?php
  2.     /**
  3.      * This file contains the base class for the view plugins
  4.      * @copyright Copyright (c) 2006,2007 Mirchev Ideas Ltd. All rights reserved.
  5.      * @package MIPHPF
  6.      */
  7.  
  8.     /**
  9.      * Base class for view plugins
  10.      * The view plugins can add miscellaneous functionality into the view
  11.      * @copyright Copyright (c) 2006,2007 Mirchev Ideas Ltd. All rights reserved.
  12.      * @package MIPHPF
  13.      */
  14.     class miViewPlugin {
  15.         /**
  16.          * Reference to the view
  17.          */
  18.         protected $_view;
  19.         
  20.         /**
  21.          * Constructs the plugin
  22.          * 
  23.          * @param miView $view reference to the view
  24.          */
  25.         public function __construct(miView $view)
  26.         {
  27.             $this->_view = $view;
  28.             $view->registerPlugin($this);
  29.         }
  30.         
  31.         /**
  32.          * Called before an action
  33.          * 
  34.          * @param miAction $actionObj 
  35.          */
  36.         public function preProcessAction(miAction $actionObj)
  37.         {
  38.         }
  39.         
  40.         /**
  41.          * Called after an action
  42.          * 
  43.          * @param miAction $actionObj 
  44.          * @param boolean $actionResult the result returned from the action
  45.          */
  46.         public function postProcessAction(miAction $actionObj, $actionResult)
  47.         {
  48.         }
  49.         
  50.         /**
  51.          * Called by the action, indicating particluar step
  52.          * 
  53.          * @param miAction $actionObj 
  54.          * @param string $actionStep the name of the current step in the action
  55.          */
  56.         public function processActionStep(miAction $actionObj, $actionStep)
  57.         {
  58.         }
  59.     }
  60. ?>

Documentation generated on Thu, 08 May 2008 16:57:59 +0300 by phpDocumentor 1.4.1