MDL-33887 delay string fetching in PAGE->requires->string_for_js() till page footer

This should resolve problems with language switching such as when forcing course language.
This commit is contained in:
Petr Škoda 2012-06-21 09:58:45 +02:00
parent 2cbdaa77ea
commit af225f6c9c
2 changed files with 68 additions and 6 deletions

View file

@ -63,6 +63,11 @@ class page_requirements_manager {
*/
protected $stringsforjs = array();
/**
* @var array List of get_string $a parameters - used for validation only.
*/
protected $stringsforjs_as = array();
/**
* @var array List of JS variables to be initialised
*/
@ -861,15 +866,17 @@ class page_requirements_manager {
* @param mixed $a any extra data to add into the string (optional).
*/
public function string_for_js($identifier, $component, $a = NULL) {
$string = get_string($identifier, $component, $a);
if (!$component) {
throw new coding_exception('The $module parameter is required for page_requirements_manager::string_for_js.');
throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
}
if (isset($this->stringsforjs[$component][$identifier]) && $this->stringsforjs[$component][$identifier] !== $string) {
if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
throw new coding_exception("Attempt to re-define already required string '$identifier' " .
"from lang file '$component'. Did you already ask for it with a different \$a? {$this->stringsforjs[$component][$identifier]} !== $string");
"from lang file '$component' with different \$a parameter?");
}
if (!isset($this->stringsforjs[$component][$identifier])) {
$this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
$this->stringsforjs_as[$component][$identifier] = $a;
}
$this->stringsforjs[$component][$identifier] = $string;
}
/**
@ -1212,7 +1219,13 @@ class page_requirements_manager {
// add all needed strings
if (!empty($this->stringsforjs)) {
$output .= html_writer::script(js_writer::set_variable('M.str', $this->stringsforjs));
$strings = array();
foreach ($this->stringsforjs as $component=>$v) {
foreach($v as $indentifier => $langstring) {
$strings[$component][$indentifier] = $langstring->out();
}
}
$output .= html_writer::script(js_writer::set_variable('M.str', $strings));
}
// add variables