L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-69553 output: Handle pre-loading multiline string defines

Browse Source 
Before this patch strings that were declared over multiple lines in
a template would not be parsed correctly.

{{#str}}value,
mod_forum{{/str}}

would have been been parsed to get_string('value', 'core')

{{#str}}
value, mod_forum
{{/str}}

would have been been parsed to get_string('', 'core')
This commit is contained in:
Neill Magill
2020-10-21 10:08:23 +01:00
parent bb3f9ee492
commit e9506c638b
1 changed files with 48 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/classes/output/mustache_template_source_loader.php
+48 -10
View File
@@ -319,17 +319,9 @@ class mustache_template_source_loader {
break;
case Mustache_Tokenizer::T_SECTION:
if ($name == 'str') {
// The token that containts the string identifiers (key and component) should
// immediately follow the #str token.
$identifiertoken = isset($tokens[$index + 1]) ? $tokens[$index + 1] : null;
list($id, $component) = $this->get_string_identifiers($tokens, $index);
if ($identifiertoken) {
// The string identifier is the key and component comma separated.
$identifierstring = $identifiertoken['value'];
$parts = explode(',', $identifierstring);
$id = $parts[0];
// Default to 'core' for the component, if not specified.
$component = isset($parts[1]) ? $parts[1] : 'core';
if ($id) {
$strings = $addtodependencies($strings, $component, $id);
}
}
@@ -343,4 +335,50 @@ class mustache_template_source_loader {
'strings' => $strings
];
}
/**
* Gets the identifier and component of the string.
*
* The string could be defined on one, or multiple lines.
*
* @param array $tokens The templates token.
* @param int $start The index of the start of the string token.
* @return array A list of the string identifier and component.
*/
protected function get_string_identifiers(array $tokens, int $start): array {
$current = $start + 1;
$parts = [];
// Get the contents of the string tag.
while ($tokens[$current]['type'] !== Mustache_Tokenizer::T_END_SECTION) {
if (!isset($tokens[$current]['value']) || empty(trim($tokens[$current]['value']))) {
// An empty line, so we should ignore it.
$current++;
continue;
}
// We need to remove any spaces before and after the string.
$nospaces = trim($tokens[$current]['value']);
// We need to remove any trailing commas so that the explode will not add an
// empty entry where two paramters are on multiple lines.
$clean = rtrim($nospaces, ',');
// We separate the parts of a string with commas.
$subparts = explode(',', $clean);
// Store the parts.
$parts = array_merge($parts, $subparts);
$current++;
}
// The first text should be the first part of a str tag.
$id = isset($parts[0]) ? trim($parts[0]) : null;
// Default to 'core' for the component, if not specified.
$component = isset($parts[1]) ? trim($parts[1]) : 'core';
return [$id, $component];
}
}