classes/form/Form.inc.php

<?php

// $Id: Form.inc.php,v 1.36 2008/07/01 01:16:09 asmecher Exp $


import('form.FormError');
import('form.validation.FormValidator');

class Form {

   var $_template;

   var $_data;

   var $_checks;

   var $_errors;

   var $errorsArray;

   var $errorFields;

   function Form($template) {
      $this->_template = $template;
      $this->_data = array();
      $this->_checks = array();
      $this->_errors = array();
      $this->errorsArray = array();
      $this->errorFields = array();
   }

   function display() {
      $templateMgr = &TemplateManager::getManager();
      $templateMgr->setCacheability(CACHEABILITY_NO_STORE);
      $templateMgr->register_function('fieldLabel', array(&$this, 'smartyFieldLabel'));
      $templateMgr->register_function('form_language_chooser', array(&$this, 'smartyFormLanguageChooser'));

      $templateMgr->assign($this->_data);
      $templateMgr->assign('isError', !$this->isValid());
      $templateMgr->assign('errors', $this->getErrorsArray());

      $templateMgr->assign('formLocales', Locale::getSupportedLocales());

      // Determine the current locale to display fields with
      $formLocale = Request::getUserVar('formLocale');
      if (empty($formLocale) || !in_array($formLocale, array_keys(Locale::getAllLocales()))) {
         $formLocale = Locale::getLocale();
      }
      $templateMgr->assign('formLocale', $formLocale);

      $templateMgr->display($this->_template);
   }

   function getData($key) {
      return isset($this->_data[$key]) ? $this->_data[$key] : null;
   }

   function setData($key, $value) {

      if (is_string($value)) $value = Core::cleanVar($value);

      $this->_data[$key] = $value;
   }

   function initData() {
   }

   function readInputData() {
   }

   function validate() {
      if (!isset($this->errorsArray)) {
         $this->getErrorsArray();
      }

      foreach ($this->_checks as $check) {
         if (!isset($this->errorsArray[$check->getField()]) && !$check->isValid()) {
            if (method_exists($check, 'getErrorFields') && method_exists($check, 'isArray') && call_user_func(array(&$check, 'isArray'))) {
               $errorFields = call_user_func(array(&$check, 'getErrorFields'));
               for ($i=0, $count=count($errorFields); $i < $count; $i++) {
                  $this->addError($errorFields[$i], $check->getMessage());
                  $this->errorFields[$errorFields[$i]] = 1;
               }
            } else {
               $this->addError($check->getField(), $check->getMessage());
               $this->errorFields[$check->getField()] = 1;
            }
         }
      }
      return $this->isValid();
   }

   function execute() {
   }

   function getLocaleFieldNames() {
      return array();
   }

   function isLocaleResubmit() {
      $formLocale = Request::getUserVar('formLocale');
      return (!empty($formLocale));
   }

   function getFormLocale() {
      $formLocale = Request::getUserVar('formLocale');
      if (empty($formLocale)) $formLocale = Locale::getLocale();
      return $formLocale;
   }

   function readUserVars($vars) {
      foreach ($vars as $k) {
         $this->setData($k, Request::getUserVar($k));
      }
   }

   function readUserDateVars($vars) {
      foreach ($vars as $k) {
         $this->setData($k, Request::getUserDateVar($k));
      }
   }

   function addCheck($formValidator) {
      $this->_checks[] = &$formValidator;
   }

   function addError($field, $message) {
      $this->_errors[] = &new FormError($field, $message);
   }

   function addErrorField($field) {
      $this->errorFields[$field] = 1;
   }

   function isValid() {
      return empty($this->_errors);
   }

   function getErrorsArray() {
      $this->errorsArray = array();
      foreach ($this->_errors as $error) {
         if (!isset($this->errorsArray[$error->getField()])) {
            $this->errorsArray[$error->getField()] = $error->getMessage();
         }
      }
      return $this->errorsArray;
   }

   function smartyFieldLabel($params, &$smarty) {
      if (isset($params) && !empty($params)) {
         if (isset($params['key'])) {
            $params['label'] = Locale::translate($params['key'], $params);
         }

         if (isset($this->errorFields[$params['name']])) {
            $class = ' class="error"';
         } else {
            $class = '';   
         }
         echo '<label' . (isset($params['suppressId']) ? '' : ' for="' . $params['name'] . '"'), $class, '>', $params['label'], (isset($params['required']) && !empty($params['required']) ? '*' : ''), '</label>';
      }
   }

   function _decomposeArray($name, $value, $stack) {
      if (is_array($value)) {
         foreach ($value as $key => $subValue) {
            $newStack = $stack;
            $newStack[] = $key;
            $this->_decomposeArray($name, $subValue, $newStack);
         }
      } else {
         $name = htmlentities($name, ENT_COMPAT, LOCALE_ENCODING);
         $value = htmlentities($value, ENT_COMPAT, LOCALE_ENCODING);
         echo '<input type="hidden" name="' . $name;
         while (($item = array_shift($stack)) !== null) {
            $item = htmlentities($item, ENT_COMPAT, LOCALE_ENCODING);
            echo '[' . $item . ']';
         }
         echo '" value="' . $value . "\" />\n";
      }
   }
   function smartyFormLanguageChooser($params, &$smarty) {
      // Echo back all non-current language field values so that they
      // are not lost.
      $formLocale = $smarty->get_template_vars('formLocale');
      foreach ($this->getLocaleFieldNames() as $field) {
         $values = $this->getData($field);
         if (!is_array($values)) continue;
         foreach ($values as $locale => $value) {
            if ($locale != $formLocale) $this->_decomposeArray($field, $value, array($locale));
         }
      }

      // Display the language selector widget.
      $formLocale = $smarty->get_template_vars('formLocale');
      echo '<div id="languageSelector"><select size="1" name="formLocale" id="formLocale" onchange="changeFormAction(\'' . htmlentities($params['form'], ENT_COMPAT, LOCALE_ENCODING) . '\', \'' . htmlentities($params['url'], ENT_QUOTES, LOCALE_ENCODING) . '\')" class="selectMenu">';
      foreach (Locale::getSupportedLocales() as $locale => $name) {
         echo '<option ' . ($locale == $formLocale?'selected="selected" ':'') . 'value="' . htmlentities($locale, ENT_COMPAT, LOCALE_ENCODING) . '">' . htmlentities($name, ENT_COMPAT, LOCALE_ENCODING) . '</option>';
      }
      echo '</select></div>';
   }
}

?>

---