From 7b7bf31d4c86189199a50197b391fe0611be8a2e Mon Sep 17 00:00:00 2001
From: Andrew Nicols <andrew@nicols.co.uk>
Date: Fri, 27 Oct 2017 10:24:51 +0800
Subject: [PATCH] MDL-60587 calendar: Add helper to setup the
 calendar_information

---
 calendar/lib.php | 52 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/calendar/lib.php b/calendar/lib.php
index b4b0c2c1a8d..298c40f580e 100644
--- a/calendar/lib.php
+++ b/calendar/lib.php
@@ -998,6 +998,9 @@ class calendar_information {
     /** @var array An array of users */
     public $users = array();
 
+    /** @var context The anticipated context that the calendar is viewed in */
+    public $context = null;
+
     /**
      * Creates a new instance
      *
@@ -1032,6 +1035,55 @@ class calendar_information {
         $this->set_time($time);
     }
 
+    /**
+     * Creates and set up a instance.
+     *
+     * @param   int                     $time the unixtimestamp representing the date we want to view.
+     * @param   int                     $courseid The ID of the course the user wishes to view.
+     * @param   int                     $categoryid The ID of the category the user wishes to view
+     *                                  If a courseid is specified, this value is ignored.
+     * @return  calendar_information
+     */
+    public static function create($time, int $courseid, int $categoryid = null) : calendar_information {
+        $calendar = new static(0, 0, 0, $time);
+        if ($courseid != SITEID && !empty($courseid)) {
+            // Course ID must be valid and existing.
+            $course = get_course($courseid);
+            $calendar->context = context_course::instance($course->id);
+
+            if (!$course->visible) {
+                require_capability('moodle/course:viewhiddencourses', $calendar->context);
+            }
+
+            $courses = [$course->id => $course];
+            $category = (\coursecat::get($course->category))->get_db_record();
+        } else if (!empty($categoryid)) {
+            $course = get_site();
+            $courses = calendar_get_default_courses();
+
+            // Filter available courses to those within this category or it's children.
+            $ids = [$categoryid];
+            $category = \coursecat::get($categoryid);
+            $ids = array_merge($ids, array_keys($category->get_children()));
+            $courses = array_filter($courses, function($course) use ($ids) {
+                return array_search($course->category, $ids) !== false;
+            });
+            $category = $category->get_db_record();
+
+            $calendar->context = context_coursecat::instance($categoryid);
+        } else {
+            $course = get_site();
+            $courses = calendar_get_default_courses();
+            $category = null;
+
+            $calendar->context = context_system::instance();
+        }
+
+        $calendar->set_sources($course, $courses, $category);
+
+        return $calendar;
+    }
+
     /**
      * Set the time period of this instance.
      *