class.t3lib_modsettings.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_modSettings {

   var $type = 'perm';

   var $prefix = '';

   var $storeList = array();

   var $storedSettings = array();

   var $msg = '';


   var $formName = 'storeControl';



   var $writeDevLog = 0;            // write messages into the devlog?




   /********************************
    *
    * Init / setup
    *
    ********************************/



   function init($prefix='', $storeList='')  {
      $this->prefix = $prefix;
      $this->setStoreList($storeList);
      $this->type = 'perm';

         // enable dev logging if set
      if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_modSettings.php']['writeDevLog']) $this->writeDevLog = TRUE;
      if (TYPO3_DLOG) $this->writeDevLog = TRUE;
   }

   function setSessionType($type='ses')   {
      $this->type = $type;
   }




   /********************************
    *
    * Store list - which values should be stored
    *
    ********************************/



   function setStoreList($storeList)   {
      $this->storeList = is_array($storeList) ? $storeList : t3lib_div::trimExplode(',',$storeList,1);

      if ($this->writeDevLog) t3lib_div::devLog('Store list:'.implode(',',$this->storeList), 't3lib_modSettings', 0);
   }


   function addToStoreList($storeList) {
      $storeList = is_array($storeList) ? $storeList : t3lib_div::trimExplode(',',$storeList,1);
      $this->storeList = array_merge($this->storeList, $storeList);

      if ($this->writeDevLog) t3lib_div::devLog('Store list:'.implode(',',$this->storeList), 't3lib_modSettings', 0);
   }


   function addToStoreListFromPrefix($prefix='') {
      global $SOBE;

      $prefix = $prefix ? $prefix : $this->prefix;

      reset($SOBE->MOD_SETTINGS);
      while(list($key)=each($SOBE->MOD_SETTINGS))  {
         if (ereg('^'.$prefix,$key)) {
            $this->storeList[$key]=$key;
         }
      }

      unset($this->storeList[$this->prefix.'_storedSettings']);

      if ($this->writeDevLog) t3lib_div::devLog('Store list:'.implode(',',$this->storeList), 't3lib_modSettings', 0);
   }





   /********************************
    *
    * Process storage array
    *
    ********************************/



   function initStorage()  {
      global $SOBE;

      $storedSettings = unserialize($SOBE->MOD_SETTINGS[$this->prefix.'_storedSettings']);
      $this->storedSettings = $this->cleanupStorageArray($storedSettings);
   }



   function cleanupStorageArray($storedSettings)   {

      $storedSettings = is_array($storedSettings) ? $storedSettings : array();

         // clean up the array
      foreach($storedSettings as $id => $sdArr) {
         if (!is_array($sdArr)) unset($storedSettings[$id]);
         if (!is_array($sdArr['data'])) unset($storedSettings[$id]);
         if (!trim($sdArr['title']))   $storedSettings[$id]['title'] = '[no title]';
      }

      return $storedSettings;
   }


   function compileEntry($data)  {
      global $SOBE;

      $storageData = array();
      foreach($this->storeList as $MS_key)   {
         $storageData[$MS_key] = $SOBE->MOD_SETTINGS[$MS_key];
      }
      $storageArr = array (
                  'title' => $data['title'],
                  'desc' => (string)$data['desc'],
                  'data' => $storageData,
                  'user' => NULL,
                  'tstamp' => time(),
               );
      $storageArr = $this->processEntry($storageArr);

      return $storageArr;
   }


   function getStoredData($storeIndex, $writeArray=array()) {
      if ($this->storedSettings[$storeIndex])   {
         foreach($this->storeList as $k)  {
            $writeArray[$k] = $this->storedSettings[$storeIndex]['data'][$k];
         }
      }
      return $writeArray;
   }



   function processStoreControl($mconfName='')  {

      $this->initStorage();

      #debug($this->storedSettings, '$this->storedSettings', __LINE__, __FILE__);

      $storeControl = t3lib_div::_GP('storeControl');
      $storeIndex = $storeControl['STORE'];

      if ($this->writeDevLog) t3lib_div::devLog('Store command: '.t3lib_div::arrayToLogString($storeControl), 't3lib_modSettings', 0);

      $msg = '';
      $saveSettings = FALSE;
      $writeArray = array();

      if (is_array($storeControl)) {

         //
         // processing LOAD
         //

         if ($storeControl['LOAD'] AND $storeIndex)   {
               $writeArray = $this->getStoredData($storeIndex, $writeArray);
               $saveSettings = TRUE;
               $msg = "'".$this->storedSettings[$storeIndex]['title']."' preset loaded!";

         //
         // processing SAVE
         //

         } elseif ($storeControl['SAVE']) {
            if (trim($storeControl['title'])) {

                  // get the data to store
               $newEntry = $this->compileEntry($storeControl);

                  // create an index for the storage array
               if (!$storeIndex) {
                  $storeIndex = t3lib_div::shortMD5($newEntry['title']);
               }

                  // add data to the storage array
               $this->storedSettings[$storeIndex] = $newEntry;

               $saveSettings = TRUE;
               $msg = "'".$newEntry['title']."' preset saved!";

            } else {
               $msg = 'Please enter a name for the preset!';
            }

         //
         // processing REMOVE
         //

         } elseif ($storeControl['REMOVE'] AND $storeIndex) {
               // Removing entry
            $msg = "'".$this->storedSettings[$storeIndex]['title']."' preset entry removed!";
            unset($this->storedSettings[$storeIndex]);

            $saveSettings = TRUE;
         }


         $this->msg = $msg;

         if ($saveSettings)   {
            $this->writeStoredSetting($writeArray, $mconfName);
         }

      }
      return $this->msg;
   }


   function writeStoredSetting($writeArray=array(), $mconfName='') {
      global $SOBE;

         // for debugging: just removes all module data from user settings
      # $GLOBALS['BE_USER']->pushModuleData($SOBE->MCONF['name'],array());

      unset($this->storedSettings[0]); // making sure, index 0 is not set!
      $this->storedSettings = $this->cleanupStorageArray($this->storedSettings);
      $writeArray[$this->prefix.'_storedSettings'] = serialize($this->storedSettings);

      $SOBE->MOD_SETTINGS = t3lib_BEfunc::getModuleData($SOBE->MOD_MENU, $writeArray, ($mconfName?$mconfName:$SOBE->MCONF['name']), $this->type);

      if ($this->writeDevLog) t3lib_div::devLog('Settings stored:'.$this->msg, 't3lib_modSettings', 0);
   }



   /********************************
    *
    * GUI
    *
    ********************************/



   function getStoreControl($showElements='load,remove,save', $useOwnForm=TRUE)  {
      global $TYPO3_CONF_VARS;

      $showElements = t3lib_div::trimExplode(',', $showElements, 1);

      $this->initStorage();

         // Preset selector
      $opt=array();
      $opt[] = '<option value="0">   </option>';
      foreach($this->storedSettings as $id => $v)  {
         $opt[] = '<option value="'.$id.'">'.htmlspecialchars($v['title']).'</option>';
      }
      $storedEntries = count($opt)>1;



      $codeTD = array();


         // LOAD, REMOVE, but also show selector so you can overwrite an entry with SAVE
      if($storedEntries AND (count($showElements))) {

            // selector box
         $onChange = 'document.forms[\''.$this->formName.'\'][\'storeControl[title]\'].value= this.options[this.selectedIndex].value!=0 ? this.options[this.selectedIndex].text : \'\';';
         $code = '
               <select name="storeControl[STORE]" onChange="'.htmlspecialchars($onChange).'">
               '.implode('
                  ', $opt).'
               </select>';

            // load button
         if(in_array('load', $showElements)) {
               $code.= '
               <input type="submit" name="storeControl[LOAD]" value="Load" /> ';
         }

            // remove button
         if(in_array('remove', $showElements)) {
               $code.= '
               <input type="submit" name="storeControl[REMOVE]" value="Remove" /> ';
         }
         $codeTD[] = '<td width="1%">Preset:</td>';
         $codeTD[] = '<td nowrap="nowrap">'.$code.'&nbsp;&nbsp;</td>';
      }


         // SAVE
      if(in_array('save', $showElements)) {
         $onClick = (!$storedEntries) ? '' : 'if (document.forms[\''.$this->formName.'\'][\'storeControl[STORE]\'].options[document.forms[\''.$this->formName.'\'][\'storeControl[STORE]\'].selectedIndex].value<0) return confirm(\'Are you sure you want to overwrite the existing entry?\');';
         $code = '<input name="storeControl[title]" value="" type="text" max="80" width="25"> ';
         $code.= '<input type="submit" name="storeControl[SAVE]" value="Save" onClick="'.htmlspecialchars($onClick).'" />';
         $codeTD[] = '<td nowrap="nowrap">'.$code.'</td>';
      }


      $codeTD = implode ('
         ', $codeTD);

      if (trim($code)) {
         $code = '
         <!--
            Store control
         -->
         <table border="0" cellpadding="3" cellspacing="0" width="100%">
            <tr class="bgColor4">
            '.$codeTD.'
            </tr>
         </table>
         ';
      }

      if ($this->msg)   {
         $code.= '
         <div><strong>'.htmlspecialchars($this->msg).'</strong></div>';
      }
#TODO need to add parameters
      if ($useOwnForm AND trim($code)) {
         $code = '
      <form action="'.t3lib_div::getIndpEnv('SCRIPT_NAME').'" method="POST" name="'.$this->formName.'" enctype="'.$TYPO3_CONF_VARS['SYS']['form_enctype'].'">'.$code.'</form>';
      }

      return $code;
   }




   /********************************
    *
    * Misc
    *
    ********************************/


   function processEntry($storageArr) {
      return $storageArr;
   }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_modSettings.php'])   {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_modSettings.php']);
}
?>

---