hcuTranslate.i

<?php
/*
 * Polish can cause problems with it's two byte characters.  Also, we aren't being consistent on if we are using the ISO or UTF-8 standard.
 *  New flag was added 'html_decode'.  When this is set, the msg function will return all string after decoding all &#XXX entity codes.  This is
 *  done because browsers seem to work better if these are set, especially in kendo, where it does not decode the entity codes..
 *
 *  Upon getting ready to have the borwser display the text hcu_displayHtml should be used
 *  mws 12/30/14
 *
 */

define("HCU_DISPLAY_AS_HTML", 0);
define("HCU_DISPLAY_AS_JS", 1);
define("HCU_DISPLAY_AS_RAW", 2);

class hcu_talk_base {
  var $messages;
  var $lang;
  var $html_decode;
  var $langName;
  var $js_find;
  var $combo_replace;

  // construtor - load the correct language module
  function __construct($Flang) {
    if ( !$Flang ) $Flang = "en_US";
    $includeFile = "hcuTranslate." . $Flang . ".i";

    include(dirname(__FILE__) . '/../includes/' . $includeFile );
    // assign the variables from the language module
    $this->js_find = $js_find;
    $this->js_replace = $js_replace;
    $this->lowerChar = $lowerChar;
    $this->upperChar = $upperChar;
    $this->messages = $messages;

    // ** Allow the Loading Config file to set whether to decode all values coming from dictionary
      // ** Mostly needed for &# encoding
    $this->html_decode = ($html_decode == 1 ? 1 : 0);

    // save the language, too
    $this->lang = $lang;
    $this->langName = $langName;

  }

  function get_lang() {
    return $this->lang;
  }

  function msg($s, $displayType = HCU_DISPLAY_AS_RAW) {
    /*
     *
     * msg may return the message encoded the following ways
     * NOTE: hcuTranslate.xx_US are all saved with html entities &#xxx; or &word;
     *
     * HCU_DISPLAY_AS_JS
     *   This option will return any html entity represented by its \u (unicode) value
     *   this is done with search and replace arrays defining the entities to replace
     *
     *
     * HCU_DISPLAY_AS_RAW
     *   This option will return any html entity represented by its UTF-8 character encoding
     *
     * HCU_DISPLAY_AS_HTML
     *    This option will return the entity codes represented with the html entities intact
     *
     */
    if (isset($this->messages[$s])) {
      if ($displayType == HCU_DISPLAY_AS_JS) {
        return $this->js_msg($s);
      } elseif ($displayType == HCU_DISPLAY_AS_RAW) {
        return html_entity_decode($this->messages[$s], ENT_QUOTES, 'UTF-8');
      } else {
        return $this->messages[$s];
      }
    } else {
      error_log("HCU Message error in " . $_SERVER['PHP_SELF'] . ": $this->lang,message:'$s'");
    }
  }
  function js_msg($s) {
    if (isset($this->messages[$s])) {
      $js_msg =  $this->messages[$s];
      $js_msg = str_replace(
                $this->js_find,
                $this->js_replace,
                $js_msg);
      return $js_msg;
    } else {
      error_log("HCU Message error in " . $_SERVER['PHP_SELF'] . ": $this->lang,message:'$s'");
    }
  }
  function combo_msg($s, $displayType = HCU_DISPLAY_AS_HTML, $find="", $replace="") {
    if (isset($this->messages[$s])) {
      $combo_msg =  $this->messages[$s];
      $combo_msg = str_replace($find,$replace,$combo_msg);
      if ($displayType == HCU_DISPLAY_AS_JS) {

          # html entities to unicode for MSIE javascript

          $combo_msg = str_replace(
                $this->js_find,
                $this->js_replace,
                $combo_msg);
      } elseif ($displayType == HCU_DISPLAY_AS_RAW) {
        return html_entity_decode($combo_msg, ENT_QUOTES, 'UTF-8');
      }
      return $combo_msg;
    } else {
      error_log("HCU Message error in " . $_SERVER['PHP_SELF'] . ": $this->lang,message:'$s'");
    }
  }
  /*
   * message_decode
   * this function will return the the full array of messages, however, if the class is setup to use
   * html_decode, then it will call the necessary functions
   */
  function message_decode() {

    $copyMessage = $this->messages;

    if ($this->html_decode == 1) {
      // walk through array, decode the html entities
      array_walk($copyMessage, function(&$value, $key) {
        $value = html_entity_decode($value, ENT_COMPAT, 'UTF-8');
      });
    }

    return $copyMessage;
  }
}