[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   * Class representing an action a user should take.
  19   *
  20   * @package    core_calendar
  21   * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_calendar\local\event\value_objects;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core_calendar\local\event\entities\action_interface;
  30  
  31  /**
  32   * Class representing an action a user should take
  33   *
  34   * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  35   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class action implements action_interface {
  38      /**
  39       * @var string $name The action's name.
  40       */
  41      protected $name;
  42  
  43      /**
  44       * @var \moodle_url $url The action's URL.
  45       */
  46      protected $url;
  47  
  48      /**
  49       * @var int $itemcount How many items there are to action.
  50       */
  51      protected $itemcount;
  52  
  53      /**
  54       * @var bool $actionable Whether or not the event is currently actionable.
  55       */
  56      protected $actionable;
  57  
  58      /**
  59       * Constructor.
  60       *
  61       * @param string      $name       The action's name.
  62       * @param \moodle_url $url        The action's URL.
  63       * @param int         $itemcount  How many items there are to action.
  64       * @param bool        $actionable Whether or not the event is currently actionable.
  65       */
  66      public function __construct(
  67          $name,
  68          \moodle_url $url,
  69          $itemcount,
  70          $actionable
  71      ) {
  72          $this->name = $name;
  73          $this->url = $url;
  74          $this->itemcount = $itemcount;
  75          $this->actionable = $actionable;
  76      }
  77  
  78      public function get_name() {
  79          return $this->name;
  80      }
  81  
  82      public function get_url() {
  83          return $this->url;
  84      }
  85  
  86      public function get_item_count() {
  87          return $this->itemcount;
  88      }
  89  
  90      public function is_actionable() {
  91          return $this->actionable;
  92      }
  93  }