Source for file TableFeature.php

Documentation is available at TableFeature.php

  1. <?php
  2.     /**
  3.      * The miTableFeature class
  4.      * 
  5.      * @copyright Copyright (c) 2003-2006 Mirchev Ideas Ltd. All rights reserved.
  6.      * @package MIPHPF
  7.      */
  8.     
  9.     /**
  10.      * miTableFeature base class
  11.      * Each table feature subclasses this class
  12.      * 
  13.      * @copyright Copyright (c) 2003-2006 Mirchev Ideas Ltd. All rights reserved.
  14.      * @package MIPHPF
  15.      * @abstract the subclasses must implement getValues()
  16.      */
  17.     abstract class miTableFeature {
  18.         
  19.         /**
  20.          * A reference to the miTable object associated with this table feature
  21.          * 
  22.          * @access protected
  23.          */
  24.         protected $_table;
  25.         
  26.         /**
  27.          * Constructs a table feature
  28.          */
  29.         function __construct($table)
  30.         {
  31.             $this->_table = $table;
  32.             $table->addTableFeature($this);
  33.         }
  34.         
  35.         /**
  36.          * Get the feature values
  37.          * 
  38.          * @access public
  39.          * @return array 
  40.          */
  41.         abstract public function getValues();
  42.         
  43.         /**
  44.          * Returns associative array with params that save the feature state
  45.          * 
  46.          * @return array 
  47.          */
  48.         public function getStateParams()
  49.         {
  50.             return array();
  51.         }
  52.         
  53.         /**
  54.          * Returns the value of a named state variable
  55.          * Returns the default value if the state variable is not set
  56.          *
  57.          * @param string $name 
  58.          * @param mixed $defaultValue 
  59.          * @return mixed 
  60.          */
  61.         protected function getStateValue($name, $defaultValue)
  62.         {
  63.             $state = $this->_table->getState();
  64.             return isset($state[$name]) ? $state[$name] : $defaultValue;
  65.         }
  66.     }
  67. ?>

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