Source for file TableCustomParams.php

Documentation is available at TableCustomParams.php

  1. <?php
  2.     /**
  3.      * Table Custom Params Class
  4.      * 
  5.      * @copyright Copyright (c) 2003-2006 Mirchev Ideas Ltd. All rights reserved.
  6.      * @package MIPHPF
  7.      */
  8.  
  9.     /**
  10.      * Handles custom params
  11.      * 
  12.      * @copyright Copyright (c) 2003-2006 Mirchev Ideas Ltd. All rights reserved.
  13.      * @package MIPHPF
  14.      */
  15.     class miTableCustomParams extends miTableFeature {
  16.         
  17.         const TMPL_VAR_CUSTOM_PARAMS = 'RL_PARAMS';
  18.         
  19.         /**
  20.          * Used to forward parameters from top-level to sub-level views
  21.          * It usually contains ID(s) of a field that limits the managed records
  22.          * 
  23.          * @access protected
  24.          */
  25.         protected $_recordLocatorParams = array();
  26.         
  27.         
  28.         /**
  29.          * Sets the record locator params. They are used to forward params from
  30.          * top level to sub-level views
  31.          * 
  32.          * @access public
  33.          * @param array the record locator params
  34.          */
  35.         public function setRecordLocatorParams($rlParams)
  36.         {
  37.             $this->_recordLocatorParams = $rlParams;
  38.         }
  39.  
  40.         
  41.         /**
  42.          * Gets the array of record locator params
  43.          * 
  44.          * @access public
  45.          * @return array the record locator params
  46.          */
  47.         public function getRecordLocatorParams()
  48.         {
  49.             return $this->_recordLocatorParams;
  50.         }
  51.  
  52.         /**
  53.          * Get the feature values
  54.          * 
  55.          * @access public
  56.          * @return array 
  57.          */
  58.         public function getValues()
  59.         {
  60.             $values = array();
  61.             $values[self::TMPL_VAR_CUSTOM_PARAMS] = $this->_table->paramsArrayToUrl($this->getStateParams());
  62.             foreach ($this->_recordLocatorParams as $name => $value) {
  63.                 $values[strtoupper($name)] = $value;
  64.             }
  65.             return $values;
  66.         }
  67.         
  68.         /**
  69.          * Returns associative array with params that save the feature state
  70.          * 
  71.          * @return array 
  72.          */
  73.         public function getStateParams()
  74.         {
  75.             return $this->_recordLocatorParams;
  76.         }
  77.     }
  78. ?>

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