[Summary view]

   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   * Event factory class.
  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\factories;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core_calendar\local\event\exceptions\invalid_callback_exception;
  30  use core_calendar\local\event\entities\event_interface;
  31  
  32  /**
  33   * Event factory class.
  34   *
  35   * @copyright 2017 Cameron Ball <cameron@cameron1729.xyz>
  36   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class event_factory extends event_abstract_factory {
  39  
  40      protected function apply_component_action(event_interface $event) {
  41          $callbackapplier = $this->actioncallbackapplier;
  42          $callbackresult = $callbackapplier($event);
  43  
  44          if (!$callbackresult instanceof event_interface) {
  45              throw new invalid_callback_exception(
  46                  'Event factory action callback applier must return an instance of event_interface');
  47          }
  48  
  49          return $callbackresult;
  50      }
  51  
  52      protected function expose_event(event_interface $event) {
  53          $callbackapplier = $this->visibilitycallbackapplier;
  54          $callbackresult = $callbackapplier($event);
  55  
  56          if (!is_bool($callbackresult)) {
  57              throw new invalid_callback_exception('Event factory visibility callback applier must return true or false');
  58          }
  59  
  60          return $callbackresult === true ? $event : null;
  61      }
  62  }