From ec126f624e22ea609dc5e7e53aa8e2e90ade8ffd Mon Sep 17 00:00:00 2001
From: Mark Nelson <markn@moodle.com>
Date: Mon, 16 Sep 2013 16:33:36 +0800
Subject: [PATCH] MDL-41792 block_calendar_month: tidy existing code

---
 blocks/calendar_month/block_calendar_month.php | 60 ++++++++++++++++++++------
 1 file changed, 48 insertions(+), 12 deletions(-)

diff --git a/blocks/calendar_month/block_calendar_month.php b/blocks/calendar_month/block_calendar_month.php
index abe28089e9e..01adcaf9864 100644
--- a/blocks/calendar_month/block_calendar_month.php
+++ b/blocks/calendar_month/block_calendar_month.php
@@ -1,22 +1,58 @@
 <?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/>.
 
+/**
+ * Handles displaying the calendar block.
+ *
+ * @package    block_calendar_month
+ * @copyright  2004 Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class block_calendar_month extends block_base {
-    function init() {
+
+    /**
+     * Initialise the block.
+     */
+    public function init() {
         $this->title = get_string('pluginname', 'block_calendar_month');
     }
 
-    function preferred_width() {
+    /**
+     * Return preferred_width.
+     *
+     * @return int
+     */
+    public function preferred_width() {
         return 210;
     }
 
-    function get_content() {
-        global $USER, $CFG, $SESSION;
-        $cal_m = optional_param( 'cal_m', 0, PARAM_INT );
-        $cal_y = optional_param( 'cal_y', 0, PARAM_INT );
+    /**
+     * Return the content of this block.
+     *
+     * @return stdClass the content
+     */
+    public function get_content() {
+        global $CFG;
+
+        $calm = optional_param('cal_m', 0, PARAM_INT);
+        $caly = optional_param('cal_y', 0, PARAM_INT);
 
         require_once($CFG->dirroot.'/calendar/lib.php');
 
-        if ($this->content !== NULL) {
+        if ($this->content !== null) {
             return $this->content;
         }
 
@@ -41,12 +77,12 @@ class block_calendar_month extends block_base {
 
         list($courses, $group, $user) = calendar_set_filters($filtercourse);
         if ($issite) {
-            // For the front page
-            $this->content->text .= calendar_get_mini($courses, $group, $user, $cal_m, $cal_y, 'frontpage', $courseid);
-            // No filters for now
+            // For the front page.
+            $this->content->text .= calendar_get_mini($courses, $group, $user, $calm, $caly, 'frontpage', $courseid);
+            // No filters for now.
         } else {
-            // For any other course
-            $this->content->text .= calendar_get_mini($courses, $group, $user, $cal_m, $cal_y, 'course', $courseid);
+            // For any other course.
+            $this->content->text .= calendar_get_mini($courses, $group, $user, $calm, $caly, 'course', $courseid);
             $this->content->text .= '<h3 class="eventskey">'.get_string('eventskey', 'calendar').'</h3>';
             $this->content->text .= '<div class="filters calendar_filters">'.calendar_filter_controls($this->page->url).'</div>';
         }
-- 
2.11.4.GIT