[Summary view] [Print] [Text 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   * Evidence persistent file.
  19   *
  20   * @package    core_competency
  21   * @copyright  2015 Frédéric Massart - FMCorz.net
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_competency;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  use coding_exception;
  29  use context;
  30  use context_user;
  31  use lang_string;
  32  use moodle_exception;
  33  use stdClass;
  34  
  35  /**
  36   * Evidence persistent class.
  37   *
  38   * @package    core_competency
  39   * @copyright  2015 Frédéric Massart - FMCorz.net
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class evidence extends persistent {
  43  
  44      const TABLE = 'competency_evidence';
  45  
  46      /** Action logging. */
  47      const ACTION_LOG = 0;
  48      /** Action rating a competency when no rating is set. */
  49      const ACTION_COMPLETE = 2;
  50      /** Action rating a competency. */
  51      const ACTION_OVERRIDE = 3;
  52  
  53      /**
  54       * Return the definition of the properties of this model.
  55       *
  56       * @return array
  57       */
  58      protected static function define_properties() {
  59          return array(
  60              'usercompetencyid' => array(
  61                  'type' => PARAM_INT
  62              ),
  63              'contextid' => array(
  64                  'type' => PARAM_INT
  65              ),
  66              'action' => array(
  67                  'type' => PARAM_INT,
  68                  'choices' => array(self::ACTION_LOG, self::ACTION_COMPLETE, self::ACTION_OVERRIDE)
  69              ),
  70              'actionuserid' => array(
  71                  'type' => PARAM_INT,
  72                  'default' => null,
  73                  'null' => NULL_ALLOWED
  74              ),
  75              'descidentifier' => array(
  76                  'type' => PARAM_STRINGID
  77              ),
  78              'desccomponent' => array(
  79                  'type' => PARAM_COMPONENT
  80              ),
  81              'desca' => array(
  82                  'type' => PARAM_RAW,
  83                  'default' => null,
  84                  'null' => NULL_ALLOWED
  85              ),
  86              'url' => array(
  87                  'type' => PARAM_URL,
  88                  'default' => null,
  89                  'null' => NULL_ALLOWED
  90              ),
  91              'grade' => array(
  92                  'type' => PARAM_INT,
  93                  'default' => null,
  94                  'null' => NULL_ALLOWED
  95              ),
  96              'note' => array(
  97                  'type' => PARAM_NOTAGS,
  98                  'default' => null,
  99                  'null' => NULL_ALLOWED
 100              )
 101          );
 102      }
 103  
 104      /**
 105       * Return the competency linked to this.
 106       *
 107       * @return competency
 108       */
 109      public function get_competency() {
 110          return user_competency::get_competency_by_usercompetencyid($this->get_usercompetencyid());
 111      }
 112  
 113      /**
 114       * Convenience method to get the description $a.
 115       *
 116       * @return mixed
 117       */
 118      public function get_desca() {
 119          $value = $this->get('desca');
 120          if ($value !== null) {
 121              $value = json_decode($value);
 122          }
 123          return $value;
 124      }
 125  
 126      /**
 127       * Convenience method to get the description.
 128       *
 129       * @return lang_string
 130       */
 131      public function get_description() {
 132          return new lang_string($this->get('descidentifier'), $this->get('desccomponent'), $this->get_desca());
 133      }
 134  
 135      /**
 136       * Convenience method to set the description $a.
 137       *
 138       * @param mixed $value
 139       * @return mixed
 140       */
 141      public function set_desca($value) {
 142          if ($value !== null) {
 143              if (!is_scalar($value) && !is_array($value) && !($value instanceof stdClass)) {
 144                  throw new coding_exception('$a format not supported.');
 145              }
 146              $value = json_encode($value);
 147          }
 148          $this->set('desca', $value);
 149      }
 150  
 151      /**
 152       * Convenience method handling moodle_urls.
 153       *
 154       * @param null|string|moodle_url $url The URL.
 155       */
 156      public function set_url($url) {
 157          if ($url instanceof \moodle_url) {
 158              $url = $url->out(false);
 159          }
 160          $this->set('url', $url);
 161      }
 162  
 163      /**
 164       * Validate the action user ID.
 165       *
 166       * @param  int $value A user ID.
 167       * @return true|lang_string
 168       */
 169      protected function validate_actionuserid($value) {
 170          if ($value !== null && !\core_user::is_real_user($value)) {
 171              return new lang_string('invaliddata', 'error');
 172          }
 173          return true;
 174      }
 175  
 176      /**
 177       * Validate the context ID.
 178       *
 179       * @param  int $value
 180       * @return true|lang_string
 181       */
 182      protected function validate_contextid($value) {
 183          try {
 184              context::instance_by_id($value);
 185          } catch (moodle_exception $e) {
 186              // That does not look good...
 187              return new lang_string('invaliddata', 'error');
 188          }
 189          return true;
 190      }
 191  
 192      /**
 193       * Validate the description $a.
 194       *
 195       * @param string $value
 196       * @return true|lang_string
 197       */
 198      protected function validate_desca($value) {
 199          if ($value === null) {
 200              return true;
 201          }
 202  
 203          $desc = json_decode($value);
 204          if ($desc === null && json_last_error() !== JSON_ERROR_NONE) {
 205              return new lang_string('invaliddata', 'error');
 206          }
 207  
 208          return true;
 209      }
 210  
 211      /**
 212       * Validate the description identifier.
 213       *
 214       * Only validate string existence during create. If the string is removed later on we should
 215       * not prevent this model from being updated. Alternatively we could check if the string has
 216       * changed before performing the check but this overhead is not required for now.
 217       * An evidence should usually never be updated anyway.
 218       *
 219       * @param  string $value
 220       * @return true|lang_string
 221       */
 222      protected function validate_descidentifier($value) {
 223          if (!$this->get_id() && !get_string_manager()->string_exists($value, $this->get('desccomponent'))) {
 224              return new lang_string('invalidevidencedesc', 'core_competency');
 225          }
 226  
 227          return true;
 228      }
 229  
 230      /**
 231       * Validate the grade.
 232       *
 233       * For performance reason we do not validate that the grade is a valid item of the
 234       * scale associated with the competency or framework.
 235       *
 236       * @param int $value The value.
 237       * @return true|lang_string
 238       */
 239      protected function validate_grade($value) {
 240          if ($value !== null && $value <= 0) {
 241              return new lang_string('invalidgrade', 'core_competency');
 242          }
 243  
 244          $action = $this->get('action');
 245          if ($value === null && $action == self::ACTION_COMPLETE) {
 246              return new lang_string('invalidgrade', 'core_competency');
 247  
 248          } else if ($value !== null && $action == self::ACTION_LOG) {
 249              return new lang_string('invalidgrade', 'core_competency');
 250          }
 251  
 252          if ($value !== null) {
 253              // TODO MDL-52243 Use a core method to validate the grade_scale item.
 254              // Check if grade exist in the scale item values.
 255              $competency = $this->get_competency();
 256              if (!array_key_exists($value - 1, $competency->get_scale()->scale_items)) {
 257                  return new lang_string('invalidgrade', 'core_competency');
 258              }
 259          }
 260  
 261          return true;
 262      }
 263  
 264      /**
 265       * Validate the user competency.
 266       *
 267       * @param  int $value
 268       * @return true|lang_string
 269       */
 270      protected function validate_usercompetencyid($value) {
 271          if (!user_competency::record_exists($value)) {
 272              return new lang_string('invaliddata', 'error');
 273          }
 274          return true;
 275      }
 276  
 277      /**
 278       * Whether the current user can delete an evidence in the context of a user.
 279       *
 280       * @param int $userid The user ID the evidence belongs to.
 281       * @return bool
 282       */
 283      public static function can_delete_user($userid) {
 284          return has_capability('moodle/competency:evidencedelete', context_user::instance($userid));
 285      }
 286  
 287      /**
 288       * Load a list of records in a context for a user competency.
 289       *
 290       * @param int $usercompetencyid The id of the user competency.
 291       * @param context $context Context to filter the evidence list.
 292       * @param string $sort The field from the evidence table to sort on.
 293       * @param string $order The sort direction
 294       * @param int $skip Limitstart.
 295       * @param int $limit Number of rows to return.
 296       *
 297       * @return \core_competency\persistent[]
 298       */
 299      public static function get_records_for_usercompetency($usercompetencyid,
 300                                                            \context $context,
 301                                                            $sort = '',
 302                                                            $order = 'ASC',
 303                                                            $skip = 0,
 304                                                            $limit = 0) {
 305          global $DB;
 306  
 307          $params = array(
 308              'usercompid' => $usercompetencyid,
 309              'path' => $context->path . '/%',
 310              'contextid' => $context->id
 311          );
 312  
 313          if (!empty($sort)) {
 314              $sort = ' ORDER BY e.' . $sort . ' ' . $order . ', e.id ASC';
 315          } else {
 316              $sort = ' ORDER BY e.id ASC';
 317          }
 318  
 319          $sql = 'SELECT e.*
 320                    FROM {' . static::TABLE . '} e
 321                    JOIN {context} c ON c.id = e.contextid
 322                   WHERE (c.path LIKE :path OR c.id = :contextid)
 323                     AND e.usercompetencyid = :usercompid
 324                   ' . $sort;
 325          $records = $DB->get_records_sql($sql, $params, $skip, $limit);
 326          $instances = array();
 327  
 328          foreach ($records as $record) {
 329              $newrecord = new static(0, $record);
 330              array_push($instances, $newrecord);
 331          }
 332          return $instances;
 333      }
 334  
 335  }