first commit

calendar/classes/local/event/proxies/cm_info_proxy.php

@@ -0,0 +1,83 @@
+<?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/>.
+
+/**
+ * Course module cm_info proxy.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_calendar\local\event\proxies;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Course module stdClass proxy.
+ *
+ * This implementation differs from the regular std_proxy in that it takes
+ * a module name and instance instead of an id to construct the proxied class.
+ *
+ * This is needed as the event table does not store the id of course modules
+ * instead it stores the module name and instance.
+ *
+ * @copyright 2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cm_info_proxy implements proxy_interface {
+    /** @var \stdClass */
+    protected $base;
+    /** @var  \cm_info */
+    protected $cm;
+
+    /**
+     * cm_info_proxy constructor.
+     *
+     * @param string $modname The module name.
+     * @param int $instance The module instance.
+     * @param int $courseid course id this module belongs to
+     */
+    public function __construct($modname, $instance, $courseid) {
+        $this->base = (object)['course' => $courseid, 'modname' => $modname, 'instance' => $instance];
+    }
+
+    /**
+     * Retrieve a member of the proxied class.
+     *
+     * @param string $member The name of the member to retrieve
+     * @return mixed The member.
+     */
+    public function get($member) {
+        if ($this->base && property_exists($this->base, $member)) {
+            return $this->base->{$member};
+        }
+
+        return $this->get_proxied_instance()->{$member};
+    }
+
+    /**
+     * Get the full instance of the proxied class.
+     *
+     * @return \cm_info
+     */
+    public function get_proxied_instance() {
+        if (!$this->cm) {
+            $this->cm = get_fast_modinfo($this->base->course)->instances[$this->base->modname][$this->base->instance];
+        }
+        return $this->cm;
+    }
+}

calendar/classes/local/event/proxies/coursecat_proxy.php

@@ -0,0 +1,90 @@
+<?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/>.
+
+/**
+ * Course category proxy.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_calendar\local\event\proxies;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Course category proxy.
+ *
+ * This returns an instance of a coursecat rather than a stdClass.
+ *
+ * @copyright  2017 Andrew Nicols <andrew@nicols.co.uk>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class coursecat_proxy implements proxy_interface {
+    /**
+     * @var int $id The ID of the database record.
+     */
+    protected $id;
+
+    /**
+     * @var \stdClass $base Base class to get members from.
+     */
+    protected $base;
+
+    /**
+     * @var \core_course_category $category The proxied instance.
+     */
+    protected $category;
+
+    /**
+     * coursecat_proxy constructor.
+     *
+     * @param int       $id       The ID of the record in the database.
+     */
+    public function __construct($id) {
+        $this->id = $id;
+        $this->base = (object) [
+            'id' => $id,
+        ];
+    }
+
+    /**
+     * Retrieve a member of the proxied class.
+     *
+     * @param string $member The name of the member to retrieve
+     * @return mixed The member.
+     */
+    public function get($member) {
+        if ($this->base && property_exists($this->base, $member)) {
+            return $this->base->{$member};
+        }
+
+        return $this->get_proxied_instance()->{$member};
+    }
+
+    /**
+     * Get the full instance of the proxied class.
+     *
+     * @return \core_course_category
+     */
+    public function get_proxied_instance(): \core_course_category {
+        if (!$this->category) {
+            $this->category = \core_course_category::get($this->id, IGNORE_MISSING, true);
+        }
+        return $this->category;
+    }
+}

calendar/classes/local/event/proxies/proxy_interface.php

@@ -0,0 +1,52 @@
+<?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/>.
+
+/**
+ * Proxy interface.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_calendar\local\event\proxies;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Interface for a proxy class.
+ *
+ * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface proxy_interface {
+    /**
+     * Retrieve a member of the proxied class.
+     *
+     * @param string $member The name of the member to retrieve
+     * @throws \core_calendar\local\event\exceptions\member_does_not_exist_exception If the proxied class does not have the
+     *                                                                               requested member.
+     * @return mixed The member.
+     */
+    public function get($member);
+
+    /**
+     * Get the full instance of the proxied class.
+     *
+     * @return mixed
+     */
+    public function get_proxied_instance();
+}

calendar/classes/local/event/proxies/std_proxy.php

@@ -0,0 +1,101 @@
+<?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/>.
+
+/**
+ * std_proxy class.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_calendar\local\event\proxies;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_calendar\local\event\exceptions\member_does_not_exist_exception;
+
+/**
+ * stdClass proxy.
+ *
+ * This class is intended to proxy things like user, group, etc 'classes'
+ * It will only run the callback to load the object from the DB when necessary.
+ *
+ * @copyright 2017 Cameron Ball <cameron@cameron1729.xyz>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class std_proxy implements proxy_interface {
+    /**
+     * @var int $id The ID of the database record.
+     */
+    protected $id;
+
+    /**
+     * @var \stdClass $class The class we are proxying.
+     */
+    protected $class;
+
+    /**
+     * @var callable $callback Callback to run which will load the class to proxy.
+     */
+    protected $callback;
+
+    /**
+     * @var array $callbackargs Array of arguments to pass to the callback.
+     */
+    protected $callbackargs;
+
+    /**
+     * @var \stdClass $base Base class to get members from.
+     */
+    protected $base;
+
+
+    /**
+     * Constructor.
+     *
+     * @param int       $id       The ID of the record in the database.
+     * @param callable  $callback Callback to load the class.
+     * @param \stdClass $base     Class containing base values.
+     */
+    public function __construct($id, callable $callback, \stdClass $base = null) {
+        $this->id = $id;
+        $this->callbackargs = [$id];
+        $this->callback = $callback;
+        $this->base = $base;
+    }
+
+    public function get($member) {
+        if ($member === 'id') {
+            return $this->id;
+        }
+
+        if ($this->base && property_exists($this->base, $member)) {
+            return $this->base->{$member};
+        }
+
+        if (!property_exists($this->get_proxied_instance(), $member)) {
+            throw new member_does_not_exist_exception(sprintf('Member %s does not exist', $member));
+        }
+
+        return $this->get_proxied_instance()->{$member};
+    }
+
+    public function get_proxied_instance() {
+        $callback = $this->callback;
+        return $this->class = $this->class ? $this->class : $callback(...$this->callbackargs);
+    }
+}