.
/**
* Library functions to facilitate the use of JavaScript in Moodle.
*
* @package moodlecore
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Initialise a {@link page_requirements_manager} with the bits of JavaScript that every
* Moodle page should have.
*
* @param page_requirements_manager $requires The page_requirements_manager to initialise.
*/
function setup_core_javascript(page_requirements_manager $requires) {
global $CFG;
// JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
// Otherwise, in some situations, users will get warnings about insecure content
// on sercure pages from their web browser.
$config = array(
'wwwroot' => $CFG->httpswwwroot, // Yes, really. See above.
'sesskey' => sesskey(),
);
if (debugging('', DEBUG_DEVELOPER)) {
$config['developerdebug'] = true;
}
$requires->data_for_js('moodle_cfg', $config)->in_head();
if (debugging('', DEBUG_DEVELOPER)) {
$requires->yui_lib('logger');
}
$requires->skip_link_to('maincontent', get_string('tocontent', 'access'));
// Note that, as a short-cut, the code
// $js = "document.body.className += ' jsenabled';\n";
// is hard-coded in {@link page_requirements_manager::get_top_of_body_code)
}
/**
* This class tracks all the things that are needed by the current page.
*
* Normally, the only instance of this class you will need to work with is the
* one accessible via $PAGE->requires.
*
* Typical useage would be
*
*
* @return string The HTML required to include this JavaScript file. The caller
* is responsible for outputting this HTML promptly.
*/
public function asap() {
if ($this->is_done()) {
return;
}
if (!$this->manager->is_head_done()) {
$this->in_head();
return '';
}
$js = $this->get_js_code();
$output = ajax_generate_script_tag($js);
$this->mark_done();
return $output;
}
/**
* Indicate that the link to this JavaScript file should be output in the
* section of the HTML. If it too late for this request to be
* satisfied, an exception is thrown.
*/
public function in_head() {
if ($this->is_done() || $this->when <= page_requirements_manager::WHEN_IN_HEAD) {
return;
}
if ($this->manager->is_head_done()) {
throw new coding_exception('Too late to ask for some JavaScript code to be output in <head>.');
}
$this->when = page_requirements_manager::WHEN_IN_HEAD;
}
/**
* Indicate that the link to this JavaScript file should be output at the top
* of the section of the HTML. If it too late for this request to be
* satisfied, an exception is thrown.
*/
public function at_top_of_body() {
if ($this->is_done() || $this->when <= page_requirements_manager::WHEN_TOP_OF_BODY) {
return;
}
if ($this->manager->is_top_of_body_done()) {
throw new coding_exception('Too late to ask for some JavaScript code to be output at the top of <body>.');
}
$this->when = page_requirements_manager::WHEN_TOP_OF_BODY;
}
}
/**
* This class represents a JavaScript function that must be called from the HTML
* page. By default the call will be made at the end of the page, but you can
* chage that using the {@link asap()}, {@link in_head()}, etc. methods.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class required_js_function_call extends required_js_code {
protected $function;
protected $arguments;
protected $delay = 0;
/**
* Constructor. Normally instances of this class should not be created directly.
* Client code should create them via the page_requirements_manager
* method {@link page_requirements_manager::js_function_call()}.
*
* @param page_requirements_manager $manager the page_requirements_manager we are associated with.
* @param string $function the name of the JavaScritp function to call.
* Can be a compound name like 'YAHOO.util.Event.addListener'.
* @param array $arguments and array of arguments to be passed to the function.
* When generating the function call, this will be escaped using json_encode,
* so passing objects and arrays should work.
*/
public function __construct(page_requirements_manager $manager, $function, $arguments) {
parent::__construct($manager);
$this->function = $function;
$this->arguments = $arguments;
}
public function get_js_code() {
$quotedargs = array();
foreach ($this->arguments as $arg) {
$quotedargs[] = json_encode($arg);
}
$js = $this->function . '(' . implode(', ', $quotedargs) . ');';
if ($this->delay) {
$js = 'setTimeout(function() { ' . $js . ' }, ' . ($this->delay * 1000) . ');';
}
return $js . "\n";
}
/**
* Indicate that this function should be called in YUI's onDomReady event.
*
* Not that this is probably not necessary most of the time. Just having the
* function call at the end of the HTML should normally be sufficient.
*/
public function on_dom_ready() {
if ($this->is_done() || $this->when < page_requirements_manager::WHEN_AT_END) {
return;
}
$this->manager->yui_lib('event');
$this->when = page_requirements_manager::WHEN_ON_DOM_READY;
}
/**
* Indicate that this function should be called a certain number of seconds
* after the page has finished loading. (More exactly, a number of seconds
* after the onDomReady event fires.)
*
* @param integer $seconds the number of seconds delay.
*/
public function after_delay($seconds) {
if ($seconds) {
$this->on_dom_ready();
}
$this->delay = $seconds;
}
}
/**
* This class represents some data from PHP that needs to be made available in a
* global JavaScript variable. By default the data will be output at the end of
* the page, but you can chage that using the {@link asap()}, {@link in_head()}, etc. methods.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class required_data_for_js extends required_js_code {
protected $variable;
protected $data;
/**
* Constructor. Normally the class and its subclasses should not be created directly.
* Client code should create them via the page_requirements_manager
* method {@link page_requirements_manager::data_for_js()}.
*
* @param page_requirements_manager $manager the page_requirements_manager we are associated with.
* @param string $variable the the name of the JavaScript variable to assign the data to.
* Will probably work if you use a compound name like 'mybuttons.button[1]', but this
* should be considered an experimental feature.
* @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
* so passing objects and arrays should work.
*/
public function __construct(page_requirements_manager $manager, $variable, $data) {
parent::__construct($manager);
$this->variable = $variable;
$this->data = json_encode($data);
// json_encode immediately, so that if $data is an object (and therefore was
// passed in by reference) we get the data at the time the call was made, and
// not whatever the data happened to be when this is output.
}
public function get_js_code() {
$prefix = 'var ';
if (strpos($this->variable, '.') || strpos($this->variable, '[')) {
$prefix = '';
}
return $prefix . $this->variable . ' = ' . $this->data . ";\n";
}
}
/**
* This class represents a Javascript event handler, listening for a
* specific Event to occur on a DOM element identified by a given id.
* By default the data will be output at the end of the page, but you
* can change that using the {@link asap()}, {@link in_head()}, etc. methods.
*
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class required_event_handler extends required_js_code {
protected $id;
protected $event;
protected $function;
protected $args = array();
/**
* Constructor. Normally the class and its subclasses should not be created directly.
* Client code should create them via the page_requirements_manager
* method {@link page_requirements_manager::data_for_js()}.
*
* @param page_requirements_manager $manager the page_requirements_manager we are associated with.
* @param string $id The id of the DOM element that will be listening for the event
* @param string $event A valid DOM event (click, mousedown, change etc.)
* @param string $function The name of the function to call
* @param array $arguments An optional array of argument parameters to pass to the function
*/
public function __construct(page_requirements_manager $manager, $id, $event, $function, $args=array()) {
$manager->requires->yui_lib('event');
parent::__construct($manager);
$this->id = $id;
$this->event = $event;
$this->function = $function;
$this->args = $args;
}
public function get_js_code() {
$output = "YAHOO.util.Event.addListener($this->id, '$this->event', $this->function";
if (!empty($this->args)) {
$output .= ', ' . json_encode($this->args);
}
return $output . ");\n";
}
}
/**
* Generate a script tag containing the the specified code.
*
* @param string $js the JavaScript code
* @return string HTML, the code wrapped in \n";
} else {
return '';
}
}
/**
* Given the name of a YUI library, return a list of the .js and .css files that
* it requries.
*
* This method takes note of the $CFG->useexternalyui setting.
*
* If $CFG->debug is set to DEBUG_DEVELOPER then this method will return links to
* the -debug version of the YUI files, otherwise it will return links to the -min versions.
*
* @param string $libname the name of a YUI library, for example 'autocomplete'.
* @return array with two elementes. The first is an array of the JavaScript URLs
* that must be loaded to make this library work, in the order they should be
* loaded. The second element is a (possibly empty) list of CSS files that
* need to be loaded.
*/
function ajax_resolve_yui_lib($libname) {
global $CFG;
// Note, we always use yahoo-dom-event, even if we are only asked for part of it.
// because another part of the code may later ask for other bits. It is easier, and
// not very inefficient, just to always use (and get browsers to cache) the combined file.
static $translatelist = array(
'yahoo' => 'yahoo-dom-event',
'animation' => array('yahoo-dom-event', 'animation'),
'autocomplete' => array(
'js' => array('yahoo-dom-event', 'datasource', 'autocomplete'),
'css' => array('autocomplete/assets/skins/sam/autocomplete.css')),
'button' => array(
'js' => array('yahoo-dom-event', 'element', 'button'),
'css' => array('button/assets/skins/sam/button.css')),
'calendar' => array(
'js' => array('yahoo-dom-event', 'calendar'),
'css' => array('calendar/assets/skins/sam/calendar.css')),
'carousel' => array(
'js' => array('yahoo-dom-event', 'element', 'carousel'),
'css' => array('carousel/assets/skins/sam/carousel.css')),
'charts' => array('yahoo-dom-event', 'element', 'datasource', 'json', 'charts'),
'colorpicker' => array(
'js' => array('utilities', 'slider', 'colorpicker'),
'css' => array('colorpicker/assets/skins/sam/colorpicker.css')),
'connection' => array('yahoo-dom-event', 'connection'),
'container' => array(
'js' => array('yahoo-dom-event', 'container'),
'css' => array('container/assets/skins/sam/container.css')),
'cookie' => array('yahoo-dom-event', 'cookie'),
'datasource' => array('yahoo-dom-event', 'datasource'),
'datatable' => array(
'js' => array('yahoo-dom-event', 'element', 'datasource', 'datatable'),
'css' => array('datatable/assets/skins/sam/datatable.css')),
'dom' => 'yahoo-dom-event',
'dom-event' => 'yahoo-dom-event',
'dragdrop' => array('yahoo-dom-event', 'dragdrop'),
'editor' => array(
'js' => array('yahoo-dom-event', 'element', 'container', 'menu', 'button', 'editor'),
'css' => array('assets/skins/sam/skin.css')),
'element' => array('yahoo-dom-event', 'element'),
'event' => 'yahoo-dom-event',
'get' => array('yahoo-dom-event', 'get'),
'history' => array('yahoo-dom-event', 'history'),
'imagecropper' => array(
'js' => array('yahoo-dom-event', 'dragdrop', 'element', 'resize', 'imagecropper'),
'css' => array('assets/skins/sam/resize.css', 'assets/skins/sam/imagecropper.css')),
'imageloader' => array('yahoo-dom-event', 'imageloader'),
'json' => array('yahoo-dom-event', 'json'),
'layout' => array(
'js' => array('yahoo-dom-event', 'dragdrop', 'element', 'layout'),
'css' => array('reset-fonts-grids/reset-fonts-grids.css', 'assets/skins/sam/layout.css')),
'logger' => array(
'js' => array('yahoo-dom-event', 'logger'),
'css' => array('logger/assets/skins/sam/logger.css')),
'menu' => array(
'js' => array('yahoo-dom-event', 'container', 'menu'),
'css' => array('menu/assets/skins/sam/menu.css')),
'paginator' => array(
'js' => array('yahoo-dom-event', 'element', 'paginator'),
'css' => array('paginator/assets/skins/sam/paginator.css')),
'profiler' => array('yahoo-dom-event', 'profiler'),
'profilerviewer' => array('yuiloader-dom-event', 'element', 'profiler', 'profilerviewer'),
'resize' => array(
'js' => array('yahoo-dom-event', 'dragdrop', 'element', 'resize'),
'css' => array('assets/skins/sam/resize.css')),
'selector' => array('yahoo-dom-event', 'selector'),
'simpleeditor' => array(
'js' => array('yahoo-dom-event', 'element', 'container', 'simpleeditor'),
'css' => array('assets/skins/sam/skin.css')),
'slider' => array('yahoo-dom-event', 'gragdrop', 'slider'),
'stylesheet' => array('yahoo-dom-event', 'stylesheet'),
'tabview' => array(
'js' => array('yahoo-dom-event', 'element', 'tabview'),
'css' => array('assets/skins/sam/skin.css')),
'treeview' => array(
'js' => array('yahoo-dom-event', 'treeview'),
'css' => array('treeview/assets/skins/sam/treeview.css')),
'uploader' => array('yahoo-dom-event', 'element', 'uploader'),
'utilities' => array('yahoo-dom-event', 'connection', 'animation', 'dragdrop', 'element', 'get'),
'yuiloader' => 'yuiloader',
'yuitest' => array(
'js' => array('yahoo-dom-event', 'logger', 'yuitest'),
'css' => array('logger/assets/logger.css', 'yuitest/assets/testlogger.css')),
);
if (!isset($translatelist[$libname])) {
throw new coding_exception('Unknown YUI library ' . $libname);
}
$data = $translatelist[$libname];
if (!is_array($data)) {
$jsnames = array($data);
$cssfiles = array();
} else if (isset($data['js']) && isset($data['css'])) {
$jsnames = $data['js'];
$cssfiles = $data['css'];
} else {
$jsnames = $data;
$cssfiles = array();
}
$debugging = debugging('', DEBUG_DEVELOPER);
if ($debugging) {
$suffix = '-debug.js';
} else {
$suffix = '-min.js';
}
$libpath = $CFG->httpswwwroot . '/lib/yui/';
$externalyui = !empty($CFG->useexternalyui);
if ($externalyui) {
include($CFG->libdir.'/yui/version.php'); // Sets $yuiversion.
$libpath = 'http://yui.yahooapis.com/' . $yuiversion . '/build/';
}
$jsurls = array();
foreach ($jsnames as $js) {
if ($js == 'yahoo-dom-event') {
if ($debugging) {
$jsurls[] = $libpath . 'yahoo/yahoo' . $suffix;
$jsurls[] = $libpath . 'dom/dom' . $suffix;
$jsurls[] = $libpath . 'event/event' . $suffix;
} else {
$jsurls[] = $libpath . $js . '/' . $js . '.js';
}
} else {
$jsurls[] = $libpath . $js . '/' . $js . $suffix;
}
}
$cssurls = array();
foreach ($cssfiles as $css) {
$cssurls[] = $libpath . $css;
}
return array($jsurls, $cssurls);
}
/**
* Return the HTML required to link to a JavaScript file.
* @param $url the URL of a JavaScript file.
* @return string the required HTML.
*/
function ajax_get_link_to_script($url) {
return '' . "\n";
}
/**
* Returns whether ajax is enabled/allowed or not.
*/
function ajaxenabled($browsers = array()) {
global $CFG, $USER;
if (!empty($browsers)) {
$valid = false;
foreach ($browsers as $brand => $version) {
if (check_browser_version($brand, $version)) {
$valid = true;
}
}
if (!$valid) {
return false;
}
}
$ie = check_browser_version('MSIE', 6.0);
$ff = check_browser_version('Gecko', 20051106);
$op = check_browser_version('Opera', 9.0);
$sa = check_browser_version('Safari', 412);
if (!$ie && !$ff && !$op && !$sa) {
/** @see http://en.wikipedia.org/wiki/User_agent */
// Gecko build 20051107 is what is in Firefox 1.5.
// We still have issues with AJAX in other browsers.
return false;
}
if (!empty($CFG->enableajax) && (!empty($USER->ajax) || !isloggedin())) {
return true;
} else {
return false;
}
}
/**
* Used to create view of document to be passed to JavaScript on pageload.
* We use this class to pass data from PHP to JavaScript.
*/
class jsportal {
var $currentblocksection = null;
var $blocks = array();
/**
* Takes id of block and adds it
*/
function block_add($id, $hidden=false){
$hidden_binary = 0;
if ($hidden) {
$hidden_binary = 1;
}
$this->blocks[count($this->blocks)] = array($this->currentblocksection, $id, $hidden_binary);
}
/**
* Prints the JavaScript code needed to set up AJAX for the course.
*/
function print_javascript($courseid, $return=false) {
global $CFG, $USER, $OUTPUT;
$blocksoutput = $output = '';
for ($i=0; $iblocks); $i++) {
$blocksoutput .= "['".$this->blocks[$i][0]."',
'".$this->blocks[$i][1]."',
'".$this->blocks[$i][2]."']";
if ($i != (count($this->blocks) - 1)) {
$blocksoutput .= ',';
}
}
$output .= "";
if ($return) {
return $output;
} else {
echo $output;
}
}
}
?>