[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   * Contains class core_tag\output\tagflag
  19   *
  20   * @package   core_tag
  21   * @copyright 2016 Marina Glancy
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_tag\output;
  26  
  27  use context_system;
  28  use core_tag_tag;
  29  
  30  /**
  31   * Class to display tag flag toggle
  32   *
  33   * @package   core_tag
  34   * @copyright 2016 Marina Glancy
  35   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class tagflag extends \core\output\inplace_editable {
  38  
  39      /**
  40       * Constructor.
  41       *
  42       * @param \stdClass|core_tag_tag $tag
  43       */
  44      public function __construct($tag) {
  45          $editable = has_capability('moodle/tag:manage', context_system::instance());
  46          $value = (int)$tag->flag;
  47  
  48          parent::__construct('core_tag', 'tagflag', $tag->id, $editable, $value, $value);
  49          $this->set_type_toggle(array(0, $value ? $value : 1));
  50      }
  51  
  52      /**
  53       * Export this data so it can be used as the context for a mustache template.
  54       *
  55       * @param \renderer_base $output
  56       * @return \stdClass
  57       */
  58      public function export_for_template(\renderer_base $output) {
  59          if ($this->value) {
  60              $this->edithint = get_string('resetflag', 'core_tag');
  61              $this->displayvalue = $output->pix_icon('i/flagged', $this->edithint) .
  62                  " ({$this->value})";
  63          } else {
  64              $this->edithint = get_string('flagasinappropriate', 'core_tag');
  65              $this->displayvalue = $output->pix_icon('i/unflagged', $this->edithint);
  66          }
  67  
  68          return parent::export_for_template($output);
  69      }
  70  
  71      /**
  72       * Updates the value in database and returns itself, called from inplace_editable callback
  73       *
  74       * @param int $itemid
  75       * @param mixed $newvalue
  76       * @return \self
  77       */
  78      public static function update($itemid, $newvalue) {
  79          require_capability('moodle/tag:manage', context_system::instance());
  80          $tag = core_tag_tag::get($itemid, '*', MUST_EXIST);
  81          $newvalue = (int)clean_param($newvalue, PARAM_BOOL);
  82          if ($newvalue) {
  83              $tag->flag();
  84          } else {
  85              $tag->reset_flag();
  86          }
  87          return new self($tag);
  88      }
  89  }