[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 for cohort_role_assignment persistence.
  19   *
  20   * @package    tool_cohortroles
  21   * @copyright  2015 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace tool_cohortroles;
  25  
  26  use lang_string;
  27  use core_competency\persistent;
  28  
  29  /**
  30   * Class for loading/storing cohort_role_assignments from the DB.
  31   *
  32   * @copyright  2015 Damyon Wiese
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class cohort_role_assignment extends persistent {
  36  
  37      /** Table name for user_competency persistency */
  38      const TABLE = 'tool_cohortroles';
  39  
  40      /**
  41       * Return the definition of the properties of this model.
  42       *
  43       * @return array
  44       */
  45      protected static function define_properties() {
  46          return array(
  47              'userid' => array(
  48                  'type' => PARAM_INT,
  49              ),
  50              'roleid' => array(
  51                  'type' => PARAM_INT,
  52              ),
  53              'cohortid' => array(
  54                  'type' => PARAM_INT,
  55              )
  56          );
  57      }
  58  
  59      /**
  60       * Validate the user ID.
  61       *
  62       * @param int $value The value.
  63       * @return true|lang_string
  64       */
  65      protected function validate_userid($value) {
  66          global $DB;
  67  
  68          if (!$DB->record_exists('user', array('id' => $value))) {
  69              return new lang_string('invaliduserid', 'error');
  70          }
  71  
  72          return true;
  73      }
  74  
  75      /**
  76       * Validate the role ID.
  77       *
  78       * @param int $value The value.
  79       * @return true|lang_string
  80       */
  81      protected function validate_roleid($value) {
  82          global $DB;
  83  
  84          if (!$DB->record_exists('role', array('id' => $value))) {
  85              return new lang_string('invalidroleid', 'error');
  86          }
  87  
  88          return true;
  89      }
  90  
  91      /**
  92       * Validate the cohort ID.
  93       *
  94       * @param int $value The value.
  95       * @return true|lang_string
  96       */
  97      protected function validate_cohortid($value) {
  98          global $DB;
  99  
 100          if (!$DB->record_exists('cohort', array('id' => $value))) {
 101              return new lang_string('invalidcohortid', 'error');
 102          }
 103  
 104          return true;
 105      }
 106  }