[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   * Contains class core_cohort\output\cohortname
  19   *
  20   * @package   core_cohort
  21   * @copyright 2016 Marina Glancy
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_cohort\output;
  26  
  27  use lang_string;
  28  
  29  /**
  30   * Class to prepare a cohort name for display.
  31   *
  32   * @package   core_cohort
  33   * @copyright 2016 Marina Glancy
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class cohortname extends \core\output\inplace_editable {
  37      /**
  38       * Constructor.
  39       *
  40       * @param stdClass $cohort
  41       */
  42      public function __construct($cohort) {
  43          $cohortcontext = \context::instance_by_id($cohort->contextid);
  44          $editable = has_capability('moodle/cohort:manage', $cohortcontext);
  45          $displayvalue = format_string($cohort->name, true, array('context' => $cohortcontext));
  46          parent::__construct('core_cohort', 'cohortname', $cohort->id, $editable,
  47              $displayvalue,
  48              $cohort->name,
  49              new lang_string('editcohortname', 'cohort'),
  50              new lang_string('newnamefor', 'cohort', $displayvalue));
  51      }
  52  
  53      /**
  54       * Updates cohort name and returns instance of this object
  55       *
  56       * @param int $cohortid
  57       * @param string $newvalue
  58       * @return static
  59       */
  60      public static function update($cohortid, $newvalue) {
  61          global $DB;
  62          $cohort = $DB->get_record('cohort', array('id' => $cohortid), '*', MUST_EXIST);
  63          $cohortcontext = \context::instance_by_id($cohort->contextid);
  64          \external_api::validate_context($cohortcontext);
  65          require_capability('moodle/cohort:manage', $cohortcontext);
  66          $newvalue = clean_param($newvalue, PARAM_TEXT);
  67          if (strval($newvalue) !== '') {
  68              $record = (object)array('id' => $cohort->id, 'name' => $newvalue, 'contextid' => $cohort->contextid);
  69              cohort_update_cohort($record);
  70              $cohort->name = $newvalue;
  71          }
  72          return new static($cohort);
  73      }
  74  }