[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Course module cm_info proxy.
  19   *
  20   * @package    core_calendar
  21   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_calendar\local\event\proxies;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Course module stdClass proxy.
  31   *
  32   * This implementation differs from the regular std_proxy in that it takes
  33   * a module name and instance instead of an id to construct the proxied class.
  34   *
  35   * This is needed as the event table does not store the id of course modules
  36   * instead it stores the module name and instance.
  37   *
  38   * @copyright 2017 Cameron Ball <cameron@cameron1729.xyz>
  39   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class cm_info_proxy implements proxy_interface {
  42      /** @var \stdClass */
  43      protected $base;
  44      /** @var  \cm_info */
  45      protected $cm;
  46  
  47      /**
  48       * cm_info_proxy constructor.
  49       *
  50       * @param string $modname The module name.
  51       * @param int $instance The module instance.
  52       * @param int $courseid course id this module belongs to
  53       */
  54      public function __construct($modname, $instance, $courseid) {
  55          $this->base = (object)['course' => $courseid, 'modname' => $modname, 'instance' => $instance];
  56      }
  57  
  58      /**
  59       * Retrieve a member of the proxied class.
  60       *
  61       * @param string $member The name of the member to retrieve
  62       * @return mixed The member.
  63       */
  64      public function get($member) {
  65          if ($this->base && property_exists($this->base, $member)) {
  66              return $this->base->{$member};
  67          }
  68  
  69          return $this->get_proxied_instance()->{$member};
  70      }
  71  
  72      /**
  73       * Get the full instance of the proxied class.
  74       *
  75       * @return \stdClass
  76       */
  77      public function get_proxied_instance() {
  78          if (!$this->cm) {
  79              $this->cm = get_fast_modinfo($this->base->course)->instances[$this->base->modname][$this->base->instance];
  80          }
  81          return $this->cm;
  82      }
  83  }