class.FormUtil.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.FormUtil.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/core/class.WCMFException.php");
require_once(BASE."wcmf/lib/util/class.Message.php");
require_once(BASE."wcmf/lib/util/class.StringUtil.php");
require_once(BASE."wcmf/lib/util/class.InifileParser.php");
require_once(BASE."wcmf/lib/presentation/class.DefaultControlRenderer.php");
require_once(BASE."wcmf/lib/util/class.SessionData.php");
require_once(BASE."wcmf/lib/i18n/class.Localization.php");

/**
 * @class FormUtil
 * @ingroup Util
 * @brief FormUtil provides basic support for HTML forms.
 * It's mainly for creating input controls from definition strings.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class FormUtil
{
  var $_language = null;
  var $_controlRenderer = null;
  var $_lists = array();
  
  /**
   * Constructor
   * @param language The lanugage if FormUtil should be localization aware. Optional,
   *                 default is Localization::getDefaultLanguage()
   */
  public function FormUtil($language=null)
  {
    $this->_language = $language;
    
    // create the control renderer instance
    $objectFactory = &ObjectFactory::getInstance();
    $this->_controlRenderer = &$objectFactory->createInstanceFromConfig('implementation', 'ControlRenderer');
    if ($this->_controlRenderer == null) {
      WCMFException::throwEx('ControlRenderer not defined in section implementation.', __FILE__, __LINE__);
    }
  }
  
  /**
   * Get the delimiter for HTML input control names to be used if a control name
   * consists of different parts.
   * @return The delimitor
   * @note If 'inputFieldNameDelimiter' is given in the configuration file (section 'htmlform') 
   *       it will be taken (else it defaults to '-').
   */
  public static function getInputFieldDelimiter()
  {
    $FIELD_DELIMITER = '-';
    // try to get default field delimiter
    $parser = InifileParser::getInstance();
    if(($fieldDelimiter = $parser->getValue('inputFieldNameDelimiter', 'htmlform')) === false) {
      $fieldDelimiter = $FIELD_DELIMITER;
    }
    return $fieldDelimiter;
  }
  /**
   * Get a HTML input control for a given description.
   * @param name The name of the control (HTML name attribute)
   * @param inputType The description of the control as given in the input_type property of a value
   *        The description is of the form @code type @endcode or @code type[attributes]#list @endcode 
   *        where list must be given for the types select, radio and checkbox
   *        - type: text|password|textarea|select|radio|checkbox|file|fileex(= file with delete checkbox)
   *        - attributes: a string of attributes for the input control as used in the HTML definition (e.g. 'cols="50" rows="4"')
   *        - list: one of the following:
   *              - fix:key1[val1]|key2[val2]|... or fix:$global_array_variable
   *              -  db:key[val]|table
   *              - fkt:name|param1,param2,... global function
   *              - config:section
   * @param value The predefined value of the control (maybe comma separated list for list controls)
   * @param editable True/False if this is set false the function returns only the translated value (processed by translateValue()) [default: true]
   * @param addEmptyValue True/False if this is set true, an additional empty value is added to the input control (if not given no empty value will be added) [default: false]
   * @return The HTML control string or the translated value string depending in the editable parameter
   * @see DefaultControlRenderer::renderControl
   */
  public function getInputControl($name, $inputType, $value, $editable=true, $addEmptyValue=false)
  {
    $value = strval($value);
    $htmlString = '';
    // get definition and list from description
    if (strPos($inputType, '#'))
    {
      list($def, $list) = split('#', $inputType, 2);
      $listMap = $this->getListMap($list, $value, null, $addEmptyValue);
    }
    else {
      $def = $inputType;
    }

    // if editable, make the value a list if we have a list type and the value contains comma separators
    // if not editable, translate the value (using the translateValue() method)
    if ($editable)
    {
      if ($list != '' && strPos($value, ',')) {
        $value = split(",", $value);
      }
      else {
        $value = htmlspecialchars($value);
      }
    }
    else {
      $value = $this->translateValue($value, $inputType);
    }

    // get type and attributes from definition
    preg_match_all("/[\w][^\[\]]+/", $def, $matches);
    if (sizeOf($matches[0]) > 0) {
      list($type, $attributes) = $matches[0];
    }
    if (!$type || $type == '') {
      $type = 'text';
    }
      
    // add '[]' to name if 'multiple' selection is given in attributes
    if (strPos($attributes, 'multiple')) {
      $name .= '[]';
    }
    // get error from session
        $session = &SessionData::getInstance();
    
    // build input control
    return $this->_controlRenderer->renderControl($type, $editable, $name, $value, $session->getError($name), $attributes, $listMap, $inputType);
  }
  /**
   * Get a list of key/value pairs defined by description.
   * @param description One of the following strings:
   *        - fix:key1[val1]|key2[val2]|... or fix:$global_array_variable
   *        -  db:key[val]|table
   *        - fkt:name|param1,param2,... global function
   *        - config:section
   * @param value The selected value (maybe null, default: null)
   * @param nodeOid Oid of the node containing this value (for determining remote oids) [default: null]
   * @param addEmptyValue True/False if this is set true, an additional empty value is added to the input control (if not given no empty value will be added) [default: false]
   * @return An assoziative array containing the key/value pairs
   * @note The method will try to translate values with Message::get().
   * Keys and values are encoded using htmlentities(string, ENT_QUOTES, 'UTF-8').
   */
  private function getListMap($description, $value=null, $nodeOid=null, $addEmptyValue=false)
  {
    // check for cached result (only available if nodeOid == null)
    $mapKey = $description.$value.$addEmptyValue;
    if (isset($this->_lists[$mapKey])) {
      return $this->_lists[$mapKey];
    }
    
    $map = array();
    // get type and list from description
    if (!strPos($description, ':')) {
      WCMFException::throwEx("No type found in list definition: ".$description, __FILE__, __LINE__);
    }
    else {
      list($type, $list) = split(':', $description, 2);
    }

    // build list
    switch ($type)
    {
      case 'fix':
        // see if we have an array variable or a list definition
        if (strPos($list, '$') === 0) {
          $entries = $GLOBALS[subStr($list,1)];
        }
        else {
          $entries = split('\|', $list);
        }
        if (!is_array($entries))
        {
          WCMFException::throwEx($list." is no array.", __FILE__, __LINE__);
          return array();
        }
        // process list
        foreach($entries as $curEntry)
        {
          preg_match_all("/([^\[]*)\[*([^\]]*)\]*/", $curEntry, $matches);
          if (sizeOf($matches) > 0)
          {
            $val1 = htmlentities($matches[1][0], ENT_QUOTES, 'UTF-8');
            $val2 = htmlentities($matches[2][0], ENT_QUOTES, 'UTF-8');

            if (!function_exists('html_entity_decode')) {
              $val1 = html_entity_decode($val1, ENT_QUOTES, 'UTF-8');
            }
            if ($val2 != '')
            {
              // value given
              $map[$val1] = $val2;
            }
            else 
            {
              // only key given
              $map[$val1] = $val1;
            }
          }
        }
        break;
      case 'db':
        WCMFException::throwEx('db list type is not implemented yet!', __FILE__, __LINE__);
        break;
      case 'fkt':
        // maybe there are '|' chars in parameters
        $parts = split('\|', $list);
        $name = array_shift($parts);
        $params = join('|', $parts);
        if (function_exists($name)) {
          $map = call_user_func_array($name, split(',', $params));
        }
        else {
          WCMFException::throwEx('Function '.$name.' is not defined globally!', __FILE__, __LINE__);
        }
        break;
      case 'config':
        $parser = &InifileParser::getInstance();
        $map = $parser->getSection($list);
        if (($map = $parser->getSection($list, false)) === false) {
          WCMFException::throwEx($parser->getErrorMsg(), __FILE__, __LINE__);
        }
        break;
      case 'async':
        // load the translated value only
        $parts = split('\|', $list);
        $entityType = array_shift($parts);
        //check for (remote) oid
        if (PersistenceFacade::isValidOID($nodeOid)) {
                  $oidParts = PersistenceFacade::decomposeOID($nodeOid);
                  $oidParts['type'] = $entityType;
                  $oidParts['id'] = $value;

                  $typeOid = PersistenceFacade::composeOID($oidParts);

                  if (PersistenceFacade::isValidOID($typeOid)) {
                    $map[$value] = $this->resolveByOid($typeOid);
                  }
        } else {
              // since this may be a multivalue field, the ids may be separated by commas
              $ids = split(',', $value);
          foreach ($ids as $id)
          {
                  //$oid may be pre-set
            $oid = PersistenceFacade::composeOID(array('type' => $entityType, 'id' => $id));
            $resolvedValue = $this->resolveByOid($oid);
            if ($resolvedValue) {
                $map[$id] = $resolvedValue;
            }
          }
        }
        // fallback if the value can not be interpreted as an oid or the object does not exist
        if (sizeof($map) == 0) {
          $map = array($value => $value);
        }
        break;
      case 'asyncmult':
        // load the translated value only
        $parts = split('\|', $list);
        $persistenceFacade = &PersistenceFacade::getInstance();
        foreach($parts as $key=>$entityType)
        {
          // since this may be a multivalue field, the ids may be separated by commas
          $ids = split(',', $value);
          foreach ($ids as $id)
          {
            $oid = PersistenceFacade::composeOID(array('type' => $entityType, 'id' => $id));
            if (PersistenceFacade::isValidOID($oid))
            {
              $localization = &Localization::getInstance();
              $obj = &$persistenceFacade->load($oid, BUILDDEPTH_SINGLE);
              if ($obj != null) {
                // localize object if requested
                if ($this->_language != null) {
                  $localization->loadTranslation($obj, $this->_language);
                }
                $map[$id] = $obj->getDisplayValue();
              }
            }
          }
        }
        // fallback if the value can not be interpreted as an oid or the object does not exist
        if (sizeof($map) == 0) {
          $map = array($value => $value);
        }
        break;
      default:
        WCMFException::throwEx('Unknown list type: '.$type, __FILE__, __LINE__);
        break;
    }
    
    // translate
    $result = array();
    foreach($map as $key => $value) {
      $result[strval($key)] = strval(Message::get($value));
    }
    
    // add an additional empty option if desired and not already existing
    if ($addEmptyValue == true && !array_key_exists('', $result)) {
      $result = array('' => Message::get('keine Angabe')) + $result;
    }
    
    // cache result for later access
    if ($nodeOid == null) {
      $this->_lists[$mapKey] = $result;
    }
    
    return $result;
  }
  
  /**
   * Resolves the DisplayValue of the given oid.
   * @param String $oid The oid of the requested object.
   * @return String The DisplayValue of $oid, or null if $oid is invalid.
   */
  private function resolveByOid($oid) {
        $result = null;
        
        if (PersistenceFacade::isValidOID($oid))
    {
      $persistenceFacade = &PersistenceFacade::getInstance();
      $localization = &Localization::getInstance();
      try {
        $obj = &$persistenceFacade->load($oid, BUILDDEPTH_SINGLE);
        if ($obj != null) {
          // localize object if requested
          if ($this->_language != null) {
            $localization->loadTranslation($obj, $this->_language);
          }
          $result = $obj->getDisplayValue();
        }
      } catch (Exception $ex) {
        //do nothing, $result stays null
      }
    }
        
    return $result;
  }
  
  /**
   * Translate a value with use of it's assoziated input type e.g get the location string from a location id.
   * (this is only done when the input type has a list definition).
   * @param value The value to translate (maybe comma separated list for list controls)
   * @param inputType The description of the control as given in the input_type property of a value (see CMS getInputControl())
   * @param replaceBR True/False wether to replace html line breaks with spaces or not [default:false]
   * @param nodeOid Oid of the node containing this value (for determining remote oids) [default: null]
   * @return The translated value
   */
  public function translateValue($value, $inputType, $replaceBR=false, $nodeOid = null)
  {
    // get definition and list from description
    $translated = '';
    if (strPos($inputType, '#') && $value != '')
    {
      list(,$list) = split('#', $inputType, 2);
      $map = $this->getListMap($list, $value, $nodeOid);
      if ($list != '' && strPos($value, ',')) {
        $value = split(",", $value);
      }
      if (is_array($value))
      {
        foreach($value as $curValue) {
          $translated .= $map[$curValue].", ";
        }
        $translated = StringUtil::removeTrailingComma($translated);
      }
      else {
        $translated = $map[$value];
      }
      return $translated;
    }
    $value = nl2br($value);
    if ($replaceBR) {
      $value = str_replace('<br />', ' ', $value);
    }
    return $value;
  }
}
?>