moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 17:36:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-38661 Course: Add JS category expander.

Browse source 
This adds a category expanded which:
* fetches child content in a category tree if it has not already been loaded;
* toggles relevant classes on the category node to show and hide child content; and
* applies appropriate animations to improve user experience.
This commit is contained in:
Andrew Robert Nicols 2013-03-12 11:27:45 +00:00 • committed by Marina Glancy
parent b69ec2889e
commit 53c1b936e5
18 changed files with 1437 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

39
course/category.ajax.php Normal file
View file

@ -0,0 +1,39 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Helps moodle-course-categoryexpander to serve AJAX requests
*
* @see core_course_renderer::coursecat_include_js()
* @see core_course_renderer::coursecat_ajax()
*
* @package core
* @copyright 2013 Andrew Nicols
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define('AJAX_SCRIPT', true);
require_once(dirname(__dir__) . '/config.php');
if ($CFG->forcelogin) {
require_login();
}
$PAGE->set_context(context_system::instance());
$courserenderer = $PAGE->get_renderer('core', 'course');
echo json_encode($courserenderer->coursecat_ajax());

123
course/renderer.php
View file

@ -40,6 +40,9 @@ class core_course_renderer extends plugin_renderer_base {
const COURSECAT_SHOW_COURSES_EXPANDED = 20;
const COURSECAT_SHOW_COURSES_EXPANDED_WITH_CAT = 30;
const COURSECAT_TYPE_CATEGORY = 0;
const COURSECAT_TYPE_COURSE = 1;
/**
* A cache of strings
* @var stdClass
@ -1133,7 +1136,13 @@ class core_course_renderer extends plugin_renderer_base {
$classes .= ' collapsed';
$nametag = 'div';
}
$content .= html_writer::start_tag('div', array('class' => $classes)); // .coursebox
// .coursebox
$content .= html_writer::start_tag('div', array(
'class' => $classes,
'data-courseid' => $course->id,
'data-type' => self::COURSECAT_TYPE_COURSE,
));
$content .= html_writer::start_tag('div', array('class' => 'info'));
@ -1151,6 +1160,8 @@ class core_course_renderer extends plugin_renderer_base {
$image = html_writer::empty_tag('img', array('src' => $this->output->pix_url('i/info'),
'alt' => $this->strings->summary));
$content .= html_writer::link($url, $image, array('title' => $this->strings->summary));
// Make sure JS file to expand course content is included.
$this->coursecat_include_js();
}
}
$content .= html_writer::end_tag('div'); // .moreinfo
@ -1418,6 +1429,20 @@ class core_course_renderer extends plugin_renderer_base {
return $content;
}
/**
* Make sure that javascript file for AJAX expanding of courses and categories content is included
*/
protected function coursecat_include_js() {
global $CFG;
static $jsloaded = false;
if (!$jsloaded && $CFG->enableajax) {
// We must only load this module once.
$this->page->requires->yui_module('moodle-course-categoryexpander',
'Y.Moodle.course.categoryexpander.init');
$jsloaded = true;
}
}
/**
* Returns HTML to display the subcategories and courses in the given category
*
@ -1490,6 +1515,8 @@ class core_course_renderer extends plugin_renderer_base {
$classes[] = 'with_children';
$classes[] = 'collapsed';
}
// Make sure JS file to expand category content is included.
$this->coursecat_include_js();
} else {
// load category content
$categorycontent = $this->coursecat_category_content($chelper, $coursecat, $depth);
@ -1498,9 +1525,13 @@ class core_course_renderer extends plugin_renderer_base {
$classes[] = 'with_children';
}
}
$content = html_writer::start_tag('div', array('class' => join(' ', $classes),
$content = html_writer::start_tag('div', array(
'class' => join(' ', $classes),
'data-categoryid' => $coursecat->id,
'data-depth' => $depth));
'data-depth' => $depth,
'data-showcourses' => $chelper->get_show_courses(),
'data-type' => self::COURSECAT_TYPE_CATEGORY,
));
// category name
$categoryname = $coursecat->get_formatted_name();
@ -1538,29 +1569,29 @@ class core_course_renderer extends plugin_renderer_base {
return '';
}
// Generate an id and the required JS call to make this a nice widget
$id = html_writer::random_id('course_category_tree');
$this->page->requires->js_init_call('M.util.init_toggle_class_on_click',
array($id, '.category.with_children.loaded > .info .name', 'collapsed', '.category.with_children.loaded'));
// Start content generation
$content = '';
$attributes = $chelper->get_and_erase_attributes('course_category_tree clearfix');
$content .= html_writer::start_tag('div',
array('id' => $id, 'data-showcourses' => $chelper->get_show_courses()) + $attributes);
$content .= html_writer::start_tag('div', $attributes);
if ($coursecat->get_children_count()) {
$classes = array(
'collapseexpand',
'collapse-all',
);
if ($chelper->get_subcat_depth() == 1) {
$classes[] = 'disabled';
}
// Only show the collapse/expand if there are children to expand.
$content .= html_writer::start_tag('div', array('class' => 'collapsible-actions'));
$content .= html_writer::link('#', get_string('collapseall'),
array('class' => implode(' ', $classes)));
$content .= html_writer::end_tag('div');
$this->page->requires->strings_for_js(array('collapseall', 'expandall'), 'moodle');
}
$content .= html_writer::tag('div', $categorycontent, array('class' => 'content'));
if ($coursecat->get_children_count() && $chelper->get_subcat_depth() != 1) {
// We don't need to display "Expand all"/"Collapse all" buttons if there are no
// subcategories or there is only one level of subcategories loaded
// TODO if subcategories are loaded by AJAX this might still be needed!
$content .= html_writer::start_tag('div', array('class' => 'controls'));
$content .= html_writer::tag('div', get_string('collapseall'), array('class' => 'addtoall expandall'));
$content .= html_writer::tag('div', get_string('expandall'), array('class' => 'removefromall collapseall'));
$content .= html_writer::end_tag('div');
}
$content .= html_writer::end_tag('div'); // .course_category_tree
return $content;
@ -1685,6 +1716,58 @@ class core_course_renderer extends plugin_renderer_base {
return $output;
}
/**
* Serves requests to /course/category.ajax.php
*
* In this renderer implementation it may expand the category content or
* course content.
*
* @return string
* @throws coding_exception
*/
public function coursecat_ajax() {
global $DB, $CFG;
require_once($CFG->libdir. '/coursecatlib.php');
$type = required_param('type', PARAM_INT);
if ($type === self::COURSECAT_TYPE_CATEGORY) {
// This is a request for a category list of some kind.
$categoryid = required_param('categoryid', PARAM_INT);
$showcourses = required_param('showcourses', PARAM_INT);
$depth = required_param('depth', PARAM_INT);
$category = coursecat::get($categoryid);
$chelper = new coursecat_helper();
$baseurl = new moodle_url('/course/index.php', array('categoryid' => $categoryid));
$coursedisplayoptions = array(
'limit' => $CFG->coursesperpage,
'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'courses', 'page' => 1))
);
$catdisplayoptions = array(
'limit' => $CFG->coursesperpage,
'viewmoreurl' => new moodle_url($baseurl, array('browse' => 'categories', 'page' => 1))
);
$chelper->set_show_courses($showcourses)->
set_courses_display_options($coursedisplayoptions)->
set_categories_display_options($catdisplayoptions);
return $this->coursecat_category_content($chelper, $category, $depth);
} else if ($type === self::COURSECAT_TYPE_COURSE) {
// This is a request for the course information.
$courseid = required_param('courseid', PARAM_INT);
$course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
$chelper = new coursecat_helper();
$chelper->set_show_courses(self::COURSECAT_SHOW_COURSES_EXPANDED);
return $this->coursecat_coursebox_content($chelper, $course);
} else {
throw new coding_exception('Invalid request type');
}
}
/**
* Renders html to display search result page
*

411
course/yui/build/moodle-course-categoryexpander/moodle-course-categoryexpander-debug.js vendored Normal file
View file

@ -0,0 +1,411 @@
YUI.add('moodle-course-categoryexpander', function (Y, NAME) {
/**
* Adds toggling of subcategory with automatic loading using AJAX.
*
* This also includes application of an animation to improve user experience.
*
* @module moodle-course-categoryexpander
*/
/**
* The course category expander.
*
* @constructor
* @class Y.Moodle.course.categoryexpander
*/
var CSS = {
CONTENTNODE: 'content',
COLLAPSEALL: 'collapse-all',
DISABLED: 'disabled',
LOADED: 'loaded',
NOTLOADED: 'notloaded',
SECTIONCOLLAPSED: 'collapsed',
HASCHILDREN: 'with_children'
},
SELECTORS = {
LOADEDTREES: '.with_children.loaded',
CONTENTNODE: '.content',
CATEGORYLISTENLINK: '.category .info .name',
CATEGORYSPINNERLOCATION: '.name',
CATEGORYWITHCOLLAPSEDLOADEDCHILDREN: '.category.with_children.loaded.collapsed',
CATEGORYWITHMAXIMISEDLOADEDCHILDREN: '.category.with_children.loaded:not(.collapsed)',
COLLAPSEEXPAND: '.collapseexpand',
COURSEBOX: '.coursebox',
COURSEBOXLISTENLINK: '.coursebox .moreinfo',
COURSEBOXSPINNERLOCATION: '.name a',
COURSECATEGORYTREE: '.course_category_tree',
PARENTWITHCHILDREN: '.category'
},
NS = Y.namespace('Moodle.course.categoryexpander'),
TYPE_CATEGORY = 0,
TYPE_COURSE = 1,
URL = M.cfg.wwwroot + '/course/category.ajax.php';
/**
* Set up the category expander.
*
* No arguments are required.
*
* @method init
*/
NS.init = function() {
Y.one(Y.config.doc).delegate('click', this.toggle_category_expansion, SELECTORS.CATEGORYLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.toggle_coursebox_expansion, SELECTORS.COURSEBOXLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.collapse_expand_all, SELECTORS.COLLAPSEEXPAND, this);
};
/**
* Toggle the animation of the clicked category node.
*
* @method toggle_category_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_category_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_category_expansion with the _toggle_category_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_category_expansion = NS._toggle_category_expansion;
NS.toggle_category_expansion(e);
});
};
/**
* Toggle the animation of the clicked coursebox node.
*
* @method toggle_coursebox_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_coursebox_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_coursebox_expansion with the _toggle_coursebox_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_coursebox_expansion = NS._toggle_coursebox_expansion;
NS.toggle_coursebox_expansion(e);
});
e.preventDefault();
};
NS._toggle_coursebox_expansion = function(e) {
var courseboxnode;
// Grab the parent category container - this is where the new content will be added.
courseboxnode = e.target.ancestor(SELECTORS.COURSEBOX, true);
e.preventDefault();
if (courseboxnode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(courseboxnode);
return;
}
this._toggle_generic_expansion({
parentnode: courseboxnode,
childnode: courseboxnode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.COURSEBOXSPINNERLOCATION,
data: {
courseid: courseboxnode.getData('courseid'),
type: TYPE_COURSE
}
});
};
NS._toggle_category_expansion = function(e) {
var categorynode,
categoryid,
depth;
if (e.target.test('a') || e.target.test('img')) {
// Return early if either an anchor or an image were clicked.
return;
}
// Grab the parent category container - this is where the new content will be added.
categorynode = e.target.ancestor(SELECTORS.PARENTWITHCHILDREN, true);
if (!categorynode.hasClass(CSS.HASCHILDREN)) {
// Nothing to do here - this category has no children.
return;
}
if (categorynode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(categorynode);
return;
}
// We use Data attributes to store the category.
categoryid = categorynode.getData('categoryid');
depth = categorynode.getData('depth');
if (typeof categoryid === "undefined" || typeof depth === "undefined") {
return;
}
this._toggle_generic_expansion({
parentnode: categorynode,
childnode: categorynode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.CATEGORYSPINNERLOCATION,
data: {
categoryid: categoryid,
depth: depth,
showcourses: categorynode.getData('showcourses'),
type: TYPE_CATEGORY
}
});
};
/**
* Wrapper function to handle toggling of generic types.
*
* @method _toggle_generic_expansion
* @private
* @param {Object} config
*/
NS._toggle_generic_expansion = function(config) {
if (config.spinnerhandle) {
// Add a spinner to give some feedback to the user.
spinner = M.util.add_spinner(Y, config.parentnode.one(config.spinnerhandle)).show();
}
// Fetch the data.
Y.io(URL, {
method: 'POST',
context: this,
on: {
complete: this.process_results
},
data: config.data,
"arguments": {
parentnode: config.parentnode,
childnode: config.childnode,
spinner: spinner
}
});
};
/**
* Apply the animation on the supplied node.
*
* @method run_expansion
* @private
* @param {Node} categorynode The node to apply the animation to
*/
NS.run_expansion = function(categorynode) {
var categorychildren = categorynode.one(SELECTORS.CONTENTNODE),
self = this,
ancestor = categorynode.ancestor(SELECTORS.COURSECATEGORYTREE);
// Add our animation to the categorychildren.
this.add_animation(categorychildren);
// If we already have the class, remove it before showing otherwise we perform the
// animation whilst the node is hidden.
if (categorynode.hasClass(CSS.SECTIONCOLLAPSED)) {
// To avoid a jump effect, we need to set the height of the children to 0 here before removing the SECTIONCOLLAPSED class.
categorychildren.setStyle('height', '0');
categorynode.removeClass(CSS.SECTIONCOLLAPSED);
categorychildren.fx.set('reverse', false);
} else {
categorychildren.fx.set('reverse', true);
categorychildren.fx.once('end', function(e, categorynode) {
categorynode.addClass(CSS.SECTIONCOLLAPSED);
}, this, categorynode);
}
categorychildren.fx.once('end', function(e, categorychildren) {
// Remove the styles that the animation has set.
categorychildren.setStyles({
height: '',
opacity: ''
});
// To avoid memory gobbling, remove the animation. It will be added back if called again.
this.destroy();
self.update_collapsible_actions(ancestor);
}, categorychildren.fx, categorychildren);
// Now that everything has been set up, run the animation.
categorychildren.fx.run();
};
NS.collapse_expand_all = function(e) {
// The collapse/expand button has no actual target but we need to prevent it's default
// action to ensure we don't make the page reload/jump.
e.preventDefault();
if (e.currentTarget.hasClass(CSS.DISABLED)) {
// The collapse/expand is currently disabled.
return;
}
var ancestor = e.currentTarget.ancestor(SELECTORS.COURSECATEGORYTREE);
if (!ancestor) {
return;
}
var collapseall = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (collapseall.hasClass(CSS.COLLAPSEALL)) {
this.collapse_all(ancestor);
} else {
this.expand_all(ancestor);
}
this.update_collapsible_actions(ancestor);
};
NS.expand_all = function(ancestor) {
var finalexpansions = [];
ancestor.all(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
// Expand the hidden children first without animation.
c.removeClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).removeClass(CSS.SECTIONCOLLAPSED);
} else {
finalexpansions.push(c);
}
}, this);
// Run the final expansion with animation on the visible items.
Y.all(finalexpansions).each(function(c) {
this.run_expansion(c);
}, this);
};
NS.collapse_all = function(ancestor) {
var finalcollapses = [];
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)) {
finalcollapses.push(c);
} else {
// Collapse the visible items first
this.run_expansion(c);
}
}, this);
// Run the final collapses now that the these are hidden hidden.
Y.all(finalcollapses).each(function(c) {
c.addClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).addClass(CSS.SECTIONCOLLAPSED);
}, this);
};
NS.update_collapsible_actions = function(ancestor) {
var foundmaximisedchildren = false,
// Grab the anchor for the collapseexpand all link.
togglelink = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (!togglelink) {
// We should always have a togglelink but ensure.
return;
}
// Search for any visibly expanded children.
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN).each(function(n) {
// If we can find any collapsed ancestors, skip.
if (n.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
return false;
}
foundmaximisedchildren = true;
return true;
});
if (foundmaximisedchildren) {
// At least one maximised child found. Show the collapseall.
togglelink.setHTML(M.util.get_string('collapseall', 'moodle'))
.addClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
} else {
// No maximised children found but there are collapsed children. Show the expandall.
togglelink.setHTML(M.util.get_string('expandall', 'moodle'))
.removeClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
}
};
/**
* Process the data returned by Y.io.
* This includes appending it to the relevant part of the DOM, and applying our animations.
*
* @method process_results
* @private
* @param {String} tid The Transaction ID
* @param {Object} response The Reponse returned by Y.IO
* @param {Object} ioargs The additional arguments provided by Y.IO
*/
NS.process_results = function(tid, response, args) {
var newnode,
data;
try {
data = Y.JSON.parse(response.responseText);
if (data.error) {
return new M.core.ajaxException(data);
}
} catch (e) {
return new M.core.exception(e);
}
// Insert the returned data into a new Node.
newnode = Y.Node.create(data);
// Append to the existing child location.
args.childnode.appendChild(newnode);
// Now that we have content, we can swap the classes on the toggled container.
args.parentnode
.addClass(CSS.LOADED)
.removeClass(CSS.NOTLOADED);
// Toggle the open/close status of the node now that it's content has been loaded.
this.run_expansion(args.parentnode);
// Remove the spinner now that we've started to show the content.
if (args.spinner) {
args.spinner.hide().destroy();
}
};
/**
* Add our animation to the Node.
*
* @method add_animation
* @private
* @param {Node} childnode
*/
NS.add_animation = function(childnode) {
if (typeof childnode.fx !== "undefined") {
// The animation has already been plugged to this node.
return childnode;
}
childnode.plug(Y.Plugin.NodeFX, {
from: {
height: 0,
opacity: 0
},
to: {
// This sets a dynamic height in case the node content changes.
height: function(node) {
// Get expanded height (offsetHeight may be zero).
return node.get('scrollHeight');
},
opacity: 1
},
duration: 0.2
});
return childnode;
};
}, '@VERSION@', {"requires": ["node"]});

1
course/yui/build/moodle-course-categoryexpander/moodle-course-categoryexpander-min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

411
course/yui/build/moodle-course-categoryexpander/moodle-course-categoryexpander.js vendored Normal file
View file

@ -0,0 +1,411 @@
YUI.add('moodle-course-categoryexpander', function (Y, NAME) {
/**
* Adds toggling of subcategory with automatic loading using AJAX.
*
* This also includes application of an animation to improve user experience.
*
* @module moodle-course-categoryexpander
*/
/**
* The course category expander.
*
* @constructor
* @class Y.Moodle.course.categoryexpander
*/
var CSS = {
CONTENTNODE: 'content',
COLLAPSEALL: 'collapse-all',
DISABLED: 'disabled',
LOADED: 'loaded',
NOTLOADED: 'notloaded',
SECTIONCOLLAPSED: 'collapsed',
HASCHILDREN: 'with_children'
},
SELECTORS = {
LOADEDTREES: '.with_children.loaded',
CONTENTNODE: '.content',
CATEGORYLISTENLINK: '.category .info .name',
CATEGORYSPINNERLOCATION: '.name',
CATEGORYWITHCOLLAPSEDLOADEDCHILDREN: '.category.with_children.loaded.collapsed',
CATEGORYWITHMAXIMISEDLOADEDCHILDREN: '.category.with_children.loaded:not(.collapsed)',
COLLAPSEEXPAND: '.collapseexpand',
COURSEBOX: '.coursebox',
COURSEBOXLISTENLINK: '.coursebox .moreinfo',
COURSEBOXSPINNERLOCATION: '.name a',
COURSECATEGORYTREE: '.course_category_tree',
PARENTWITHCHILDREN: '.category'
},
NS = Y.namespace('Moodle.course.categoryexpander'),
TYPE_CATEGORY = 0,
TYPE_COURSE = 1,
URL = M.cfg.wwwroot + '/course/category.ajax.php';
/**
* Set up the category expander.
*
* No arguments are required.
*
* @method init
*/
NS.init = function() {
Y.one(Y.config.doc).delegate('click', this.toggle_category_expansion, SELECTORS.CATEGORYLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.toggle_coursebox_expansion, SELECTORS.COURSEBOXLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.collapse_expand_all, SELECTORS.COLLAPSEEXPAND, this);
};
/**
* Toggle the animation of the clicked category node.
*
* @method toggle_category_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_category_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_category_expansion with the _toggle_category_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_category_expansion = NS._toggle_category_expansion;
NS.toggle_category_expansion(e);
});
};
/**
* Toggle the animation of the clicked coursebox node.
*
* @method toggle_coursebox_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_coursebox_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_coursebox_expansion with the _toggle_coursebox_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_coursebox_expansion = NS._toggle_coursebox_expansion;
NS.toggle_coursebox_expansion(e);
});
e.preventDefault();
};
NS._toggle_coursebox_expansion = function(e) {
var courseboxnode;
// Grab the parent category container - this is where the new content will be added.
courseboxnode = e.target.ancestor(SELECTORS.COURSEBOX, true);
e.preventDefault();
if (courseboxnode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(courseboxnode);
return;
}
this._toggle_generic_expansion({
parentnode: courseboxnode,
childnode: courseboxnode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.COURSEBOXSPINNERLOCATION,
data: {
courseid: courseboxnode.getData('courseid'),
type: TYPE_COURSE
}
});
};
NS._toggle_category_expansion = function(e) {
var categorynode,
categoryid,
depth;
if (e.target.test('a') || e.target.test('img')) {
// Return early if either an anchor or an image were clicked.
return;
}
// Grab the parent category container - this is where the new content will be added.
categorynode = e.target.ancestor(SELECTORS.PARENTWITHCHILDREN, true);
if (!categorynode.hasClass(CSS.HASCHILDREN)) {
// Nothing to do here - this category has no children.
return;
}
if (categorynode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(categorynode);
return;
}
// We use Data attributes to store the category.
categoryid = categorynode.getData('categoryid');
depth = categorynode.getData('depth');
if (typeof categoryid === "undefined" || typeof depth === "undefined") {
return;
}
this._toggle_generic_expansion({
parentnode: categorynode,
childnode: categorynode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.CATEGORYSPINNERLOCATION,
data: {
categoryid: categoryid,
depth: depth,
showcourses: categorynode.getData('showcourses'),
type: TYPE_CATEGORY
}
});
};
/**
* Wrapper function to handle toggling of generic types.
*
* @method _toggle_generic_expansion
* @private
* @param {Object} config
*/
NS._toggle_generic_expansion = function(config) {
if (config.spinnerhandle) {
// Add a spinner to give some feedback to the user.
spinner = M.util.add_spinner(Y, config.parentnode.one(config.spinnerhandle)).show();
}
// Fetch the data.
Y.io(URL, {
method: 'POST',
context: this,
on: {
complete: this.process_results
},
data: config.data,
"arguments": {
parentnode: config.parentnode,
childnode: config.childnode,
spinner: spinner
}
});
};
/**
* Apply the animation on the supplied node.
*
* @method run_expansion
* @private
* @param {Node} categorynode The node to apply the animation to
*/
NS.run_expansion = function(categorynode) {
var categorychildren = categorynode.one(SELECTORS.CONTENTNODE),
self = this,
ancestor = categorynode.ancestor(SELECTORS.COURSECATEGORYTREE);
// Add our animation to the categorychildren.
this.add_animation(categorychildren);
// If we already have the class, remove it before showing otherwise we perform the
// animation whilst the node is hidden.
if (categorynode.hasClass(CSS.SECTIONCOLLAPSED)) {
// To avoid a jump effect, we need to set the height of the children to 0 here before removing the SECTIONCOLLAPSED class.
categorychildren.setStyle('height', '0');
categorynode.removeClass(CSS.SECTIONCOLLAPSED);
categorychildren.fx.set('reverse', false);
} else {
categorychildren.fx.set('reverse', true);
categorychildren.fx.once('end', function(e, categorynode) {
categorynode.addClass(CSS.SECTIONCOLLAPSED);
}, this, categorynode);
}
categorychildren.fx.once('end', function(e, categorychildren) {
// Remove the styles that the animation has set.
categorychildren.setStyles({
height: '',
opacity: ''
});
// To avoid memory gobbling, remove the animation. It will be added back if called again.
this.destroy();
self.update_collapsible_actions(ancestor);
}, categorychildren.fx, categorychildren);
// Now that everything has been set up, run the animation.
categorychildren.fx.run();
};
NS.collapse_expand_all = function(e) {
// The collapse/expand button has no actual target but we need to prevent it's default
// action to ensure we don't make the page reload/jump.
e.preventDefault();
if (e.currentTarget.hasClass(CSS.DISABLED)) {
// The collapse/expand is currently disabled.
return;
}
var ancestor = e.currentTarget.ancestor(SELECTORS.COURSECATEGORYTREE);
if (!ancestor) {
return;
}
var collapseall = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (collapseall.hasClass(CSS.COLLAPSEALL)) {
this.collapse_all(ancestor);
} else {
this.expand_all(ancestor);
}
this.update_collapsible_actions(ancestor);
};
NS.expand_all = function(ancestor) {
var finalexpansions = [];
ancestor.all(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
// Expand the hidden children first without animation.
c.removeClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).removeClass(CSS.SECTIONCOLLAPSED);
} else {
finalexpansions.push(c);
}
}, this);
// Run the final expansion with animation on the visible items.
Y.all(finalexpansions).each(function(c) {
this.run_expansion(c);
}, this);
};
NS.collapse_all = function(ancestor) {
var finalcollapses = [];
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)) {
finalcollapses.push(c);
} else {
// Collapse the visible items first
this.run_expansion(c);
}
}, this);
// Run the final collapses now that the these are hidden hidden.
Y.all(finalcollapses).each(function(c) {
c.addClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).addClass(CSS.SECTIONCOLLAPSED);
}, this);
};
NS.update_collapsible_actions = function(ancestor) {
var foundmaximisedchildren = false,
// Grab the anchor for the collapseexpand all link.
togglelink = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (!togglelink) {
// We should always have a togglelink but ensure.
return;
}
// Search for any visibly expanded children.
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN).each(function(n) {
// If we can find any collapsed ancestors, skip.
if (n.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
return false;
}
foundmaximisedchildren = true;
return true;
});
if (foundmaximisedchildren) {
// At least one maximised child found. Show the collapseall.
togglelink.setHTML(M.util.get_string('collapseall', 'moodle'))
.addClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
} else {
// No maximised children found but there are collapsed children. Show the expandall.
togglelink.setHTML(M.util.get_string('expandall', 'moodle'))
.removeClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
}
};
/**
* Process the data returned by Y.io.
* This includes appending it to the relevant part of the DOM, and applying our animations.
*
* @method process_results
* @private
* @param {String} tid The Transaction ID
* @param {Object} response The Reponse returned by Y.IO
* @param {Object} ioargs The additional arguments provided by Y.IO
*/
NS.process_results = function(tid, response, args) {
var newnode,
data;
try {
data = Y.JSON.parse(response.responseText);
if (data.error) {
return new M.core.ajaxException(data);
}
} catch (e) {
return new M.core.exception(e);
}
// Insert the returned data into a new Node.
newnode = Y.Node.create(data);
// Append to the existing child location.
args.childnode.appendChild(newnode);
// Now that we have content, we can swap the classes on the toggled container.
args.parentnode
.addClass(CSS.LOADED)
.removeClass(CSS.NOTLOADED);
// Toggle the open/close status of the node now that it's content has been loaded.
this.run_expansion(args.parentnode);
// Remove the spinner now that we've started to show the content.
if (args.spinner) {
args.spinner.hide().destroy();
}
};
/**
* Add our animation to the Node.
*
* @method add_animation
* @private
* @param {Node} childnode
*/
NS.add_animation = function(childnode) {
if (typeof childnode.fx !== "undefined") {
// The animation has already been plugged to this node.
return childnode;
}
childnode.plug(Y.Plugin.NodeFX, {
from: {
height: 0,
opacity: 0
},
to: {
// This sets a dynamic height in case the node content changes.
height: function(node) {
// Get expanded height (offsetHeight may be zero).
return node.get('scrollHeight');
},
opacity: 1
},
duration: 0.2
});
return childnode;
};
}, '@VERSION@', {"requires": ["node"]});

10
course/yui/src/categoryexpander/build.json Normal file
View file

@ -0,0 +1,10 @@
{
"name": "moodle-course-categoryexpander",
"builds": {
"moodle-course-categoryexpander": {
"jsfiles": [
"categoryexpander.js"
]
}
}
}

406
course/yui/src/categoryexpander/js/categoryexpander.js vendored Normal file
View file

@ -0,0 +1,406 @@
/**
* Adds toggling of subcategory with automatic loading using AJAX.
*
* This also includes application of an animation to improve user experience.
*
* @module moodle-course-categoryexpander
*/
/**
* The course category expander.
*
* @constructor
* @class Y.Moodle.course.categoryexpander
*/
var CSS = {
CONTENTNODE: 'content',
COLLAPSEALL: 'collapse-all',
DISABLED: 'disabled',
LOADED: 'loaded',
NOTLOADED: 'notloaded',
SECTIONCOLLAPSED: 'collapsed',
HASCHILDREN: 'with_children'
},
SELECTORS = {
LOADEDTREES: '.with_children.loaded',
CONTENTNODE: '.content',
CATEGORYLISTENLINK: '.category .info .name',
CATEGORYSPINNERLOCATION: '.name',
CATEGORYWITHCOLLAPSEDLOADEDCHILDREN: '.category.with_children.loaded.collapsed',
CATEGORYWITHMAXIMISEDLOADEDCHILDREN: '.category.with_children.loaded:not(.collapsed)',
COLLAPSEEXPAND: '.collapseexpand',
COURSEBOX: '.coursebox',
COURSEBOXLISTENLINK: '.coursebox .moreinfo',
COURSEBOXSPINNERLOCATION: '.name a',
COURSECATEGORYTREE: '.course_category_tree',
PARENTWITHCHILDREN: '.category'
},
NS = Y.namespace('Moodle.course.categoryexpander'),
TYPE_CATEGORY = 0,
TYPE_COURSE = 1,
URL = M.cfg.wwwroot + '/course/category.ajax.php';
/**
* Set up the category expander.
*
* No arguments are required.
*
* @method init
*/
NS.init = function() {
Y.one(Y.config.doc).delegate('click', this.toggle_category_expansion, SELECTORS.CATEGORYLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.toggle_coursebox_expansion, SELECTORS.COURSEBOXLISTENLINK, this);
Y.one(Y.config.doc).delegate('click', this.collapse_expand_all, SELECTORS.COLLAPSEEXPAND, this);
};
/**
* Toggle the animation of the clicked category node.
*
* @method toggle_category_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_category_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_category_expansion with the _toggle_category_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_category_expansion = NS._toggle_category_expansion;
NS.toggle_category_expansion(e);
});
};
/**
* Toggle the animation of the clicked coursebox node.
*
* @method toggle_coursebox_expansion
* @private
* @param {EventFacade} e
*/
NS.toggle_coursebox_expansion = function(e) {
// Load the actual dependencies now that we've been called.
Y.use('io-base', 'json-parse', 'moodle-core-notification', 'anim', function() {
// Overload the toggle_coursebox_expansion with the _toggle_coursebox_expansion function to ensure that
// this function isn't called in the future, and call it for the first time.
NS.toggle_coursebox_expansion = NS._toggle_coursebox_expansion;
NS.toggle_coursebox_expansion(e);
});
e.preventDefault();
};
NS._toggle_coursebox_expansion = function(e) {
var courseboxnode;
// Grab the parent category container - this is where the new content will be added.
courseboxnode = e.target.ancestor(SELECTORS.COURSEBOX, true);
e.preventDefault();
if (courseboxnode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(courseboxnode);
return;
}
this._toggle_generic_expansion({
parentnode: courseboxnode,
childnode: courseboxnode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.COURSEBOXSPINNERLOCATION,
data: {
courseid: courseboxnode.getData('courseid'),
type: TYPE_COURSE
}
});
};
NS._toggle_category_expansion = function(e) {
var categorynode,
categoryid,
depth;
if (e.target.test('a') || e.target.test('img')) {
// Return early if either an anchor or an image were clicked.
return;
}
// Grab the parent category container - this is where the new content will be added.
categorynode = e.target.ancestor(SELECTORS.PARENTWITHCHILDREN, true);
if (!categorynode.hasClass(CSS.HASCHILDREN)) {
// Nothing to do here - this category has no children.
return;
}
if (categorynode.hasClass(CSS.LOADED)) {
// We've already loaded this content so we just need to toggle the view of it.
this.run_expansion(categorynode);
return;
}
// We use Data attributes to store the category.
categoryid = categorynode.getData('categoryid');
depth = categorynode.getData('depth');
if (typeof categoryid === "undefined" || typeof depth === "undefined") {
return;
}
this._toggle_generic_expansion({
parentnode: categorynode,
childnode: categorynode.one(SELECTORS.CONTENTNODE),
spinnerhandle: SELECTORS.CATEGORYSPINNERLOCATION,
data: {
categoryid: categoryid,
depth: depth,
showcourses: categorynode.getData('showcourses'),
type: TYPE_CATEGORY
}
});
};
/**
* Wrapper function to handle toggling of generic types.
*
* @method _toggle_generic_expansion
* @private
* @param {Object} config
*/
NS._toggle_generic_expansion = function(config) {
if (config.spinnerhandle) {
// Add a spinner to give some feedback to the user.
spinner = M.util.add_spinner(Y, config.parentnode.one(config.spinnerhandle)).show();
}
// Fetch the data.
Y.io(URL, {
method: 'POST',
context: this,
on: {
complete: this.process_results
},
data: config.data,
"arguments": {
parentnode: config.parentnode,
childnode: config.childnode,
spinner: spinner
}
});
};
/**
* Apply the animation on the supplied node.
*
* @method run_expansion
* @private
* @param {Node} categorynode The node to apply the animation to
*/
NS.run_expansion = function(categorynode) {
var categorychildren = categorynode.one(SELECTORS.CONTENTNODE),
self = this,
ancestor = categorynode.ancestor(SELECTORS.COURSECATEGORYTREE);
// Add our animation to the categorychildren.
this.add_animation(categorychildren);
// If we already have the class, remove it before showing otherwise we perform the
// animation whilst the node is hidden.
if (categorynode.hasClass(CSS.SECTIONCOLLAPSED)) {
// To avoid a jump effect, we need to set the height of the children to 0 here before removing the SECTIONCOLLAPSED class.
categorychildren.setStyle('height', '0');
categorynode.removeClass(CSS.SECTIONCOLLAPSED);
categorychildren.fx.set('reverse', false);
} else {
categorychildren.fx.set('reverse', true);
categorychildren.fx.once('end', function(e, categorynode) {
categorynode.addClass(CSS.SECTIONCOLLAPSED);
}, this, categorynode);
}
categorychildren.fx.once('end', function(e, categorychildren) {
// Remove the styles that the animation has set.
categorychildren.setStyles({
height: '',
opacity: ''
});
// To avoid memory gobbling, remove the animation. It will be added back if called again.
this.destroy();
self.update_collapsible_actions(ancestor);
}, categorychildren.fx, categorychildren);
// Now that everything has been set up, run the animation.
categorychildren.fx.run();
};
NS.collapse_expand_all = function(e) {
// The collapse/expand button has no actual target but we need to prevent it's default
// action to ensure we don't make the page reload/jump.
e.preventDefault();
if (e.currentTarget.hasClass(CSS.DISABLED)) {
// The collapse/expand is currently disabled.
return;
}
var ancestor = e.currentTarget.ancestor(SELECTORS.COURSECATEGORYTREE);
if (!ancestor) {
return;
}
var collapseall = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (collapseall.hasClass(CSS.COLLAPSEALL)) {
this.collapse_all(ancestor);
} else {
this.expand_all(ancestor);
}
this.update_collapsible_actions(ancestor);
};
NS.expand_all = function(ancestor) {
var finalexpansions = [];
ancestor.all(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
// Expand the hidden children first without animation.
c.removeClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).removeClass(CSS.SECTIONCOLLAPSED);
} else {
finalexpansions.push(c);
}
}, this);
// Run the final expansion with animation on the visible items.
Y.all(finalexpansions).each(function(c) {
this.run_expansion(c);
}, this);
};
NS.collapse_all = function(ancestor) {
var finalcollapses = [];
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)
.each(function(c) {
if (c.ancestor(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN)) {
finalcollapses.push(c);
} else {
// Collapse the visible items first
this.run_expansion(c);
}
}, this);
// Run the final collapses now that the these are hidden hidden.
Y.all(finalcollapses).each(function(c) {
c.addClass(CSS.SECTIONCOLLAPSED);
c.all(SELECTORS.LOADEDTREES).addClass(CSS.SECTIONCOLLAPSED);
}, this);
};
NS.update_collapsible_actions = function(ancestor) {
var foundmaximisedchildren = false,
// Grab the anchor for the collapseexpand all link.
togglelink = ancestor.one(SELECTORS.COLLAPSEEXPAND);
if (!togglelink) {
// We should always have a togglelink but ensure.
return;
}
// Search for any visibly expanded children.
ancestor.all(SELECTORS.CATEGORYWITHMAXIMISEDLOADEDCHILDREN).each(function(n) {
// If we can find any collapsed ancestors, skip.
if (n.ancestor(SELECTORS.CATEGORYWITHCOLLAPSEDLOADEDCHILDREN)) {
return false;
}
foundmaximisedchildren = true;
return true;
});
if (foundmaximisedchildren) {
// At least one maximised child found. Show the collapseall.
togglelink.setHTML(M.util.get_string('collapseall', 'moodle'))
.addClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
} else {
// No maximised children found but there are collapsed children. Show the expandall.
togglelink.setHTML(M.util.get_string('expandall', 'moodle'))
.removeClass(CSS.COLLAPSEALL)
.removeClass(CSS.DISABLED);
}
};
/**
* Process the data returned by Y.io.
* This includes appending it to the relevant part of the DOM, and applying our animations.
*
* @method process_results
* @private
* @param {String} tid The Transaction ID
* @param {Object} response The Reponse returned by Y.IO
* @param {Object} ioargs The additional arguments provided by Y.IO
*/
NS.process_results = function(tid, response, args) {
var newnode,
data;
try {
data = Y.JSON.parse(response.responseText);
if (data.error) {
return new M.core.ajaxException(data);
}
} catch (e) {
return new M.core.exception(e);
}
// Insert the returned data into a new Node.
newnode = Y.Node.create(data);
// Append to the existing child location.
args.childnode.appendChild(newnode);
// Now that we have content, we can swap the classes on the toggled container.
args.parentnode
.addClass(CSS.LOADED)
.removeClass(CSS.NOTLOADED);
// Toggle the open/close status of the node now that it's content has been loaded.
this.run_expansion(args.parentnode);
// Remove the spinner now that we've started to show the content.
if (args.spinner) {
args.spinner.hide().destroy();
}
};
/**
* Add our animation to the Node.
*
* @method add_animation
* @private
* @param {Node} childnode
*/
NS.add_animation = function(childnode) {
if (typeof childnode.fx !== "undefined") {
// The animation has already been plugged to this node.
return childnode;
}
childnode.plug(Y.Plugin.NodeFX, {
from: {
height: 0,
opacity: 0
},
to: {
// This sets a dynamic height in case the node content changes.
height: function(node) {
// Get expanded height (offsetHeight may be zero).
return node.get('scrollHeight');
},
opacity: 1
},
duration: 0.2
});
return childnode;
};

7
course/yui/src/categoryexpander/meta/categoryexpander.json Normal file
View file

@ -0,0 +1,7 @@
{
"moodle-course-categoryexpander": {
"requires": [
"node"
]
}
}