function _mail_edit_preprocess in Mail Editor 7

Preprocess a mail template, detecting conditional text that conform to a prescribed syntax.

Parameters

string $template: The template for preprocessing.

array $data: $data parameter for token_replace();

array $options: $options parameter for token_replace();

string $context:

Return value

string

This function supports ternary-type conditions to determine what text is used in a mail in a particular situation, based on token comparisons. The syntax is standard PHP/C-style ternary syntax:

{{leftOPright?true_text:false_text}}

OP is any of the common comparison operators. left and right must not contain a question mark or operator. The true_text must not contain any colon, except as a token name. true_text and false_text may contain newlines as well as a nested conditional text (one level of recursion).

1 call to _mail_edit_preprocess()

mail_edit_format in ./mail_edit.module

Formats a text using the supplied template, data, and options.

File

./mail_edit.alter.inc, line 136

Implementation of hook_mail_alter() for the Mail Editor module.

Code

function _mail_edit_preprocess($template, array $data, array $options, $context) {
  for ($n = 0; $n < 5 && ($result = preg_match_all('/{{(?P<condition>[^?#@]+?)(?P<operator>\\?|#|@)(?P<text>(({{(({{(({{(({{((.|\\n)*?)}}|.|\\n)*?)}}|.|\\n)*?)}}|.|\\n)*?)}}|.|\\n)*?))}}/', $template, $clauses)); ++$n) {

    //'(?P<text>((               .|\n)*?))';

    //'(?P<text>(({{((.|\n)*?)}}|.|\n)*?))';

    //'(?P<text>(({{(({{((.|\n)*?)}}|.|\n)*?)}}|.|\n)*?))';

    //'(?P<text>(({{(({{(({{((.|\n)*?)}}|.|\n)*?)}}|.|\n)*?)}}|.|\n)*?))';

    //'(?P<text>(({{(({{(({{(({{((.|\n)*?)}}|.|\n)*?)}}|.|\n)*?)}}|.|\n)*?)}}|.|\n)*?))';
    foreach ($clauses[0] as $i => $clause) {
      $replacement = '{{SYNTAX_ERROR}}';
      if ($clauses['operator'][$i] == '?') {
        if (!preg_match('/^(?P<true>(({{((({{((({{((({{((.|\\n)*?)}})|.|\\n)*?)}})|.|\\n)*?)}})|.|\\n)*?)}})|(\\[[^]]*?\\])|[^:[])*):(?P<false>(.|\\n)*)$/', $clauses['text'][$i], $replacements)) {

          //'(?P<true> (    ({{((.|\n)*?)}})    |    (\[[^]]*?\])    |    [^:[]    )* )';

          //'(?P<true> (    ({{((({{((.|\n)*?)}})|.|\n)*?)}})    |    (\[[^]]*?\])    |    [^:[]    )* )';

          //'(?P<true> (    ({{((({{((({{((.|\n)*?)}})|.|\n)*?)}})|.|\n)*?)}})    |    (\[[^]]*?\])    |    [^:[]    )* )';

          //'(?P<true> (    ({{((({{((({{((({{((.|\n)*?)}})|.|\n)*?)}})|.|\n)*?)}})|.|\n)*?)}})    |    (\[[^]]*?\])    |    [^:[]    )* )';
          $template = str_replace($clause, $replacement, $template);
          continue;
        }
        if (preg_match('/^(?P<operand_1>.*?)\\s*(?P<operator>==|!=|\\<\\>|\\>=|\\<=|\\>|\\<)\\s*(?P<operand_2>.*?)$/', $clauses['condition'][$i], $condition)) {
          $operand1 = token_replace($condition['operand_1'], $data, $options + array(
            'clear' => TRUE,
          ));
          $operand2 = token_replace($condition['operand_2'], $data, $options + array(
            'clear' => TRUE,
          ));
          switch ($condition['operator']) {
            case '<>':
            case '!=':
              $result = $operand1 != $operand2;
              break;
            case '==':
              $result = $operand1 == $operand2;
              break;
            case '>':
              $result = $operand1 > $operand2;
              break;
            case '<':
              $result = $operand1 < $operand2;
              break;
            case '>=':
              $result = $operand1 >= $operand2;
              break;
            case '<=':
              $result = $operand1 <= $operand2;
              break;
            default:
              $result = NULL;
          }
          if (isset($result)) {
            $replacement = $replacements[$result ? 'true' : 'false'];
            $template = str_replace($clause, $replacement, $template);
            continue;
          }
        }
      }
      if (preg_match('/^(?P<not>!?!?)(?P<condition>(\\[[^]]*?\\])|[0-9]+|[A-Za-z0-9_]+)$/', $clauses['condition'][$i], $condition)) {
        $result = $condition['condition'];
        if ($result[0] == '[') {
          $result = token_replace($result, $data, $options + array(
            'clear' => TRUE,
          ));
        }
        if ($not = $condition['not']) {
          $result = $not == '!' ? !$result : !!$result;
        }
        if ($clauses['operator'][$i] == '?') {

          /** @noinspection PhpUndefinedVariableInspection */
          $replacement = $replacements[empty($result) ? 'false' : 'true'];
        }
        else {
          if (is_bool($result)) {
            $result = (int) $result;
          }
          if ($clauses['operator'][$i] == '#' && is_numeric($result)) {
            $replacement = '';
            for ($j = 0; $j < $result; ++$j) {
              $text = $clauses['text'][$i];
              if (!$not) {
                if (preg_match_all('/\\[(?P<token>[^\\]]*?):index:#0(?P<tail>.*?)\\]/', $text, $tokens)) {
                  foreach ($tokens['token'] as $k => $token) {
                    $key = token_replace("[{$token}:keys:value:{$j}]", $data, $options);
                    $text = str_replace($tokens[0][$k], "[{$token}:value:{$key}{$tokens['tail'][$k]}]", $text);
                  }
                }
                $text = str_replace('#0', $j, $text);
                $text = str_replace('#1', $j + 1, $text);
              }
              $replacement .= $text;
            }
          }
          elseif ($clauses['operator'][$i] == '@') {
            $replacement = ($result == $context xor $not) ? $clauses['text'][$i] : '';
          }
        }
      }
      $template = str_replace($clause, $replacement, $template);
    }
  }

  // Add white space support to [*:join:?] tokens.
  if (preg_match_all('/\\[[^\\]]*?:join:(?P<sep>[^\\]]*?)\\]/', $template, $join_tokens)) {
    $marker = token_replace("[random:hash:md5]");
    foreach ($join_tokens[0] as $i => $join_token) {
      $token = str_replace($join_tokens['sep'][$i], $marker, $join_tokens[0][$i]);
      $token = token_replace($token, $data, $options);
      $token = str_replace($marker, $join_tokens['sep'][$i], $token);
      $template = str_replace($join_tokens[0][$i], $token, $template);
    }
  }
  return $template;
}