Permalink
Browse files

Merge branch 'wip-MDL-27024-MOODLE_20_STABLE' of git://github.com/sam…

…hemelryk/moodle into MOODLE_20_STABLE
  • Loading branch information...
2 parents 4f5791d + ee6181b commit 16d610019a8bd92c47fd7cb5477a5bc9e0027772 @skodak skodak committed Apr 11, 2011
Showing with 169 additions and 79 deletions.
  1. +3 −0 blocks/comments/block_comments.php
  2. +3 −2 comment/comment.js
  3. +163 −77 comment/lib.php
View
3 blocks/comments/block_comments.php
@@ -47,6 +47,9 @@ function get_content() {
$args->env = 'block_comments';
$args->component = 'block_comments';
$args->linktext = get_string('showcomments');
+ $args->notoggle = true;
+ $args->autostart = true;
+ $args->displaycancel = true;
$comment = new comment($args);
$comment->set_view_permission(true);
View
5 comment/comment.js
@@ -41,8 +41,9 @@ M.core_comment = {
this.courseid = args.courseid;
this.contextid = args.contextid;
this.env = args.env;
+ this.autostart = (args.autostart);
// expand comments?
- if (args.autostart) {
+ if (this.autostart) {
this.view(args.page);
}
// load comments
@@ -347,7 +348,7 @@ bodyContent: '<div class="comment-delete-confirm"><a href="#" id="confirmdelete-
var d = container.getStyle('display');
if (d=='none'||d=='') {
// show
- if (this.env != 'block_comments') {
+ if (this.autostart) {
this.load(page);
} else {
this.register_delete_buttons();
View
240 comment/lib.php
@@ -80,13 +80,34 @@ class comment {
*/
private $linktext;
+ /**
+ * If set to true then comment sections won't be able to be opened and closed
+ * instead they will always be visible.
+ * @var bool
+ */
+ protected $notoggle = false;
+
+ /**
+ * If set to true comments are automatically loaded as soon as the page loads.
+ * Normally this happens when the user expands the comment section.
+ * @var bool
+ */
+ protected $autostart = false;
+
+ /**
+ * If set to true a cancel button will be shown on the form used to submit comments.
+ * @var bool
+ */
+ protected $displaycancel = false;
+
// static variable will be used by non-js comments UI
private static $nonjs = false;
private static $comment_itemid = null;
private static $comment_context = null;
private static $comment_area = null;
private static $comment_page = null;
private static $comment_component = null;
+
/**
* Construct function of comment class, initialise
* class members
@@ -173,6 +194,21 @@ public function __construct($options) {
$this->ignore_permission = false;
}
+ // setup notoggle
+ if (!empty($options->notoggle)) {
+ $this->set_notoggle($options->notoggle);
+ }
+
+ // setup notoggle
+ if (!empty($options->autostart)) {
+ $this->set_autostart($options->autostart);
+ }
+
+ // setup displaycancel
+ if (!empty($options->displaycancel)) {
+ $this->set_displaycancel($options->displaycancel);
+ }
+
if (!empty($options->showcount)) {
$count = $this->count();
if (empty($count)) {
@@ -265,114 +301,164 @@ private function check_permissions() {
}
/**
+ * Gets a link for this page that will work with JS disabled.
+ *
+ * @global moodle_page $PAGE
+ * @param moodle_page $page
+ * @return moodle_url
+ */
+ public function get_nojslink(moodle_page $page = null) {
+ if ($page === null) {
+ global $PAGE;
+ $page = $PAGE;
+ }
+
+ $link = new moodle_url($page->url, array(
+ 'nonjscomment' => true,
+ 'comment_itemid' => $this->itemid,
+ 'comment_context' => $this->context->id,
+ 'comment_area' => $this->commentarea,
+ ));
+ $link->remove_params(array('nonjscomment', 'comment_page'));
+ return $link;
+ }
+
+ /**
+ * Sets the value of the notoggle option.
+ *
+ * If set to true then the user will not be able to expand and collase
+ * the comment section.
+ *
+ * @param bool $newvalue
+ */
+ public function set_notoggle($newvalue = true) {
+ $this->notoggle = (bool)$newvalue;
+ }
+
+ /**
+ * Sets the value of the autostart option.
+ *
+ * If set to true then the comments will be loaded during page load.
+ * Normally this happens only once the user expands the comment section.
+ *
+ * @param bool $newvalue
+ */
+ public function set_autostart($newvalue = true) {
+ $this->autostart = (bool)$newvalue;
+ }
+
+ /**
+ * Sets the displaycancel option
+ *
+ * If set to true then a cancel button will be shown when using the form
+ * to post comments.
+ *
+ * @param bool $newvalue
+ */
+ public function set_displaycancel($newvalue = true) {
+ $this->displaycancel = (bool)$newvalue;
+ }
+
+ /**
+ * Initialises the JavaScript that enchances the comment API.
+ *
+ * @param moodle_page $page The moodle page object that the JavaScript should be
+ * initialised for.
+ */
+ public function initialise_javascript(moodle_page $page) {
+
+ $options = new stdClass;
+ $options->client_id = $this->cid;
+ $options->commentarea = $this->commentarea;
+ $options->itemid = $this->itemid;
+ $options->page = 0;
+ $options->courseid = $this->courseid;
+ $options->contextid = $this->contextid;
+ $options->env = $this->env;
+ $options->component = $this->component;
+ $options->notoggle = $this->notoggle;
+ $options->autostart = $this->autostart;
+
+ $page->requires->js_init_call('M.core_comment.init', array($options), true);
+
+ return true;
+ }
+
+ /**
* Prepare comment code in html
* @param boolean $return
* @return mixed
*/
public function output($return = true) {
global $PAGE, $OUTPUT;
- static $template_printed;
-
- $this->link = $PAGE->url;
- $murl = new moodle_url($this->link);
- $murl->remove_params('nonjscomment');
- $murl->param('nonjscomment', 'true');
- $murl->param('comment_itemid', $this->itemid);
- $murl->param('comment_context', $this->context->id);
- $murl->param('comment_area', $this->commentarea);
- $murl->remove_params('comment_page');
- $this->link = $murl->out();
-
- $options = new stdClass();
- $options->client_id = $this->cid;
- $options->commentarea = $this->commentarea;
- $options->itemid = $this->itemid;
- $options->page = 0;
- $options->courseid = $this->courseid;
- $options->contextid = $this->contextid;
- $options->env = $this->env;
- $options->component = $this->component;
- if ($this->env == 'block_comments') {
- $options->notoggle = true;
- $options->autostart = true;
- }
+ static $template_printed;
- $PAGE->requires->js_init_call('M.core_comment.init', array($options), true);
+ $this->initialise_javascript($PAGE);
if (!empty(self::$nonjs)) {
// return non js comments interface
return $this->print_comments(self::$comment_page, $return, true);
}
- $strsubmit = get_string('savecomment');
- $strcancel = get_string('cancel');
- $strshowcomments = get_string('showcommentsnonjs');
- $sesskey = sesskey();
$html = '';
+
// print html template
// Javascript will use the template to render new comments
if (empty($template_printed) && !empty($this->viewcap)) {
- $html .= '<div style="display:none" id="cmt-tmpl">' . $this->template . '</div>';
+ $html .= html_writer::tag('div', $this->template, array('style' => 'display:none', 'id' => 'cmt-tmpl'));
$template_printed = true;
}
if (!empty($this->viewcap)) {
// print commenting icon and tooltip
- $icon = $OUTPUT->pix_url('t/collapsed');
- $html .= <<<EOD
-<div class="mdl-left">
-<a class="showcommentsnonjs" href="{$this->link}">{$strshowcomments}</a>
-EOD;
- if ($this->env != 'block_comments') {
- $html .= <<<EOD
-<a id="comment-link-{$this->cid}" class="comment-link" href="#">
- <img id="comment-img-{$this->cid}" src="$icon" alt="{$this->linktext}" title="{$this->linktext}" />
- <span id="comment-link-text-{$this->cid}">{$this->linktext} {$this->count}</span>
-</a>
-EOD;
+ $html .= html_writer::start_tag('div', array('class' => 'mdl-left'));
+ $html .= html_writer::link($this->get_nojslink($PAGE), get_string('showcommentsnonjs'), array('class' => 'showcommentsnonjs'));
+
+ if (!$this->notoggle) {
+ // If toggling is enabled (notoggle=false) then print the controls to toggle
+ // comments open and closed
+ $html .= html_writer::start_tag('a', array('class' => 'comment-link', 'id' => 'comment-link-'.$this->cid, 'href' => '#'));
+ $html .= html_writer::empty_tag('img', array('id' => 'comment-img-'.$this->cid, 'src' => $OUTPUT->pix_url('t/collapsed'), 'alt' => $this->linktext, 'title' => $this->linktext));
+ $html .= html_writer::tag('span', $this->linktext.' '.$this->count, array('id' => 'comment-link-text-'.$this->cid));
+ $html .= html_writer::end_tag('a');
}
- $html .= <<<EOD
-<div id="comment-ctrl-{$this->cid}" class="comment-ctrl">
- <ul id="comment-list-{$this->cid}" class="comment-list">
- <li class="first"></li>
-EOD;
- // in comments block, we print comments list right away
- if ($this->env == 'block_comments') {
+ $html .= html_writer::start_tag('div', array('id' => 'comment-ctrl-'.$this->cid, 'class' => 'comment-ctrl'));
+ $html .= html_writer::start_tag('ul', array('id' => 'comment-list-'.$this->cid, 'class' => 'comment-list'));
+ $html .= html_writer::tag('li', '', array('class' => 'first'));
+
+ if ($this->autostart) {
+ // If autostart has been enabled print the comments list immediatly
$html .= $this->print_comments(0, true, false);
- $html .= '</ul>';
+ $html .= html_writer::end_tag('ul'); // .comment-list
$html .= $this->get_pagination(0);
} else {
- $html .= <<<EOD
- </ul>
- <div id="comment-pagination-{$this->cid}" class="comment-pagination"></div>
-EOD;
+ $html .= html_writer::end_tag('ul'); // .comment-list
+ $html .= html_writer::tag('div', '', array('id' => 'comment-pagination-'.$this->cid, 'class' => 'comment-pagination'));
}
- // print posting textarea
if (!empty($this->postcap)) {
- $html .= <<<EOD
-<div class='comment-area'>
- <div class="bd">
- <textarea name="content" rows="2" cols="20" id="dlg-content-{$this->cid}"></textarea>
- </div>
- <div class="fd" id="comment-action-{$this->cid}">
- <a href="#" id="comment-action-post-{$this->cid}"> {$strsubmit} </a>
-EOD;
- if ($this->env != 'block_comments') {
- $html .= "<span> | </span><a href=\"#\" id=\"comment-action-cancel-{$this->cid}\"> {$strcancel} </a>";
+ // print posting textarea
+ $html .= html_writer::start_tag('div', array('class' => 'comment-area'));
+ $html .= html_writer::start_tag('div', array('class' => 'db'));
+ $html .= html_writer::tag('textarea', '', array('name' => 'content', 'rows' => 2, 'cols' => 20, 'id' => 'dlg-content-'.$this->cid));
+ $html .= html_writer::end_tag('div'); // .db
+
+ $html .= html_writer::start_tag('div', array('class' => 'fd', 'id' => 'comment-action-'.$this->cid));
+ $html .= html_writer::link('#', get_string('savecomment'), array('id' => 'comment-action-post-'.$this->cid));
+
+ if ($this->displaycancel) {
+ $html .= html_writer::tag('span', ' | ');
+ $html .= html_writer::link('#', get_string('cancel'), array('id' => 'comment-action-cancel-'.$this->cid));
}
- $html .= <<<EOD
- </div>
-</div>
-<div class="clearer"></div>
-EOD;
+
+ $html .= html_writer::end_tag('div'); // .fd
+ $html .= html_writer::end_tag('div'); // .comment-area
+ $html .= html_writer::tag('div', '', array('class' => 'clearer'));
}
- $html .= <<<EOD
-</div><!-- end of comment-ctrl -->
-</div>
-EOD;
+ $html .= html_writer::end_tag('div'); // .comment-ctrl
+ $html .= html_writer::end_tag('div'); // .mdl-left
} else {
$html = '';
}
@@ -457,11 +543,11 @@ public function get_pagination($page = 0) {
$count = $this->count();
$pages = (int)ceil($count/$CFG->commentsperpage);
if ($pages == 1 || $pages == 0) {
- return '';
+ return html_writer::tag('div', '', array('id' => 'comment-pagination-'.$this->cid, 'class' => 'comment-pagination'));
}
if (!empty(self::$nonjs)) {
// used in non-js interface
- return $OUTPUT->paging_bar($count, $page, $CFG->commentsperpage, $this->link, 'comment_page');
+ return $OUTPUT->paging_bar($count, $page, $CFG->commentsperpage, $this->get_nojslink(), 'comment_page');
} else {
// return ajax paging bar
$str = '';

0 comments on commit 16d6100

Please sign in to comment.