[Sommaire] [Imprimer]

   1  <?php
   2  /*****************************************************
   3  * This file is part of Agora, web based content management system.
   4  *
   5  * Agora is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; version 2 of the License.
   8  *
   9  * Agora is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details (file "COPYING").
  13  *
  14  * Copyright © Arnaud Martin, Antoine Pitrou et Philippe Rivière.
  15  * List of authors detailed in "copyright_fr.html" file.
  16  * E-mail : agora@sig.premier-ministre.gouv.fr
  17  * Web site : http://www.agora.gouv.fr
  18  *****************************************************/
  19  // Class for defining data source connection parameters
  20  //
  21  if (defined("_CACHE_PARAMS"))
  22      return;
  23  
  24  define("_CACHE_PARAMS", "1");
  25  
  26  /**
  27   * This class defines parameters for accessing a given cache source
  28   * @package    CACHE
  29   * @author     Erwan Le Bescond <elebescond@clever-age.com>
  30   * @access    public
  31   */
  32  
  33  class Cacheparameters {
  34  
  35      // {{{ properties
  36  
  37      /**
  38       * Cache container type (see PEAR::CACHE for more information)
  39       * @var     String
  40       * @access  private
  41       */
  42      var $_containerType;
  43  
  44      /**
  45       * Cache TTL
  46       * @var     Integer
  47       * @access  private
  48       */
  49      var $_ttl;
  50  
  51      /**
  52       * Optional parameters
  53       * @var     Array
  54       * @access  private
  55       */
  56      var $_options;
  57  
  58      // }}}
  59  
  60      // {{{ getContainerType()
  61  
  62      /**
  63       * Getter method to retreive Container type
  64       *
  65       * @return      Container type
  66       * @access      public
  67       */
  68  
  69  	function getContainerType () {
  70          return $this->_containerType;
  71      }
  72  
  73      // }}}
  74  
  75      // {{{ setContainerType()
  76  
  77      /**
  78       * Setter method to set Container type
  79       *
  80       * @param $dbEngine     new Container type
  81       * @access      public
  82       */
  83  
  84  	function setContainerType ($containerType) {
  85          $this->_containerType = $containerType;
  86      }
  87  
  88      // }}}
  89  
  90      // {{{ getTTL()
  91  
  92      /**
  93       * Getter method to retreive TTL
  94       *
  95       * @return      TTL
  96       * @access      public
  97       */
  98  
  99  	function getTTL () {
 100          return $this->_ttl;
 101      }
 102  
 103      // }}}
 104  
 105      // {{{ setTTL()
 106  
 107      /**
 108       * Setter method to set TTL
 109       *
 110       * @param $ttl     new TTL
 111       * @access      public
 112       */
 113  
 114  	function setTTL ($ttl) {
 115          $this->_ttl = $ttl;
 116      }
 117  
 118      // }}}
 119  
 120      // {{{ getOptions()
 121  
 122      /**
 123       * Getter method to retreive Options parameters
 124       *
 125       * @return      Options parameters
 126       * @access      public
 127       */
 128  
 129  	function getOptions () {
 130          return $this->_options;
 131      }
 132  
 133      // }}}
 134  
 135      // {{{ setOptions()
 136  
 137      /**
 138       * Setter method to set Pass var
 139       *
 140       * @param $dbPass     new Options parameters
 141       * @access      public
 142       */
 143  
 144  	function setOptions ($options) {
 145          $this->_options = $options;
 146      }
 147  
 148      // }}}
 149  
 150      // {{{ constructor
 151  
 152      /**
 153       * Constructor for CacheParamaters class
 154       * @param   $containerType String representing the CACHE container type.
 155       * @param   $ttl String representing the ttl
 156       * @param   $options String representing array of optional parameters
 157       * @access  public
 158       */
 159  	function CacheParameters ($containerType, $ttl, $options) {
 160          $this->_containerType = $containerType;
 161          $this->_ttl = $ttl;
 162          $this->_options = $options;
 163      }
 164  
 165  // }}}
 166  
 167  }
 168  ?>