You are here

function smarty_modifier_escape in Quiz 6.5

Same name and namespace in other branches
  1. 6.6 includes/moodle/lib/smarty/plugins/modifier.escape.php \smarty_modifier_escape()

Smarty escape modifier plugin

Type: modifier<br> Name: escape<br> Purpose: Escape the string according to escapement type @link http://smarty.php.net/manual/en/language.modifier.escape.php escape (Smarty online manual)

Parameters

string:

html|htmlall|url|quotes|hex|hexentity|javascript:

Return value

string

File

includes/moodle/lib/smarty/plugins/modifier.escape.php, line 21

Code

function smarty_modifier_escape($string, $esc_type = 'html') {
  switch ($esc_type) {
    case 'html':
      return htmlspecialchars($string, ENT_QUOTES);
    case 'htmlall':
      return htmlentities($string, ENT_QUOTES);
    case 'url':
      return rawurlencode($string);
    case 'quotes':

      // escape unescaped single quotes
      return preg_replace("%(?<!\\\\)'%", "\\'", $string);
    case 'hex':

      // escape every character into hex
      $return = '';
      for ($x = 0; $x < strlen($string); $x++) {
        $return .= '%' . bin2hex($string[$x]);
      }
      return $return;
    case 'hexentity':
      $return = '';
      for ($x = 0; $x < strlen($string); $x++) {
        $return .= '&#x' . bin2hex($string[$x]) . ';';
      }
      return $return;
    case 'decentity':
      $return = '';
      for ($x = 0; $x < strlen($string); $x++) {
        $return .= '&#' . ord($string[$x]) . ';';
      }
      return $return;
    case 'javascript':

      // escape quotes and backslashes, newlines, etc.
      return strtr($string, array(
        '\\' => '\\\\',
        "'" => "\\'",
        '"' => '\\"',
        "\r" => '\\r',
        "\n" => '\\n',
        '</' => '<\\/',
      ));
    case 'mail':

      // safe way to display e-mail address on a web page
      return str_replace(array(
        '@',
        '.',
      ), array(
        ' [AT] ',
        ' [DOT] ',
      ), $string);
    case 'nonstd':

      // escape non-standard chars, such as ms document quotes
      $_res = '';
      for ($_i = 0, $_len = strlen($string); $_i < $_len; $_i++) {
        $_ord = ord($string[$_i]);

        // non-standard char, escape it
        if ($_ord >= 126) {
          $_res .= '&#' . $_ord . ';';
        }
        else {
          $_res .= $string[$_i];
        }
      }
      return $_res;
    default:
      return $string;
  }
}