customfield/classes/data.php

   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  * Data persistent class
  19  *
  20  * @package   core_customfield
  21  * @copyright 2018 Toni Barbera <toni@moodle.com>
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 namespace core_customfield;
  26
  27 use core\persistent;
  28
  29 defined('MOODLE_INTERNAL') || die;
  30
  31 /**
  32  * Class data
  33  *
  34  * @package core_customfield
  35  * @copyright 2018 Toni Barbera <toni@moodle.com>
  36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37  */
  38 class data extends persistent {
  39
  40     /**
  41      * Database data.
  42      */
  43     const TABLE = 'customfield_data';
  44
  45     /**
  46      * Return the definition of the properties of this model.
  47      *
  48      * @return array
  49      */
  50     protected static function define_properties(): array {
  51         return array(
  52                 'fieldid'        => [
  53                         'type' => PARAM_INT,
  54                         'optional' => false,
  55                         'null'     => NULL_NOT_ALLOWED
  56                 ],
  57                 'instanceid'       => [
  58                         'type' => PARAM_INT,
  59                         'optional' => false,
  60                         'null'     => NULL_NOT_ALLOWED
  61                 ],
  62                 'intvalue'       => [
  63                         'type'     => PARAM_INT,
  64                         'optional' => true,
  65                         'default'  => null,
  66                         'null'     => NULL_ALLOWED
  67                 ],
  68                 'decvalue'       => [
  69                         'type'     => PARAM_FLOAT,
  70                         'optional' => true,
  71                         'default'  => null,
  72                         'null'     => NULL_ALLOWED
  73                 ],
  74                 'charvalue'      => [
  75                         'type'     => PARAM_TEXT,
  76                         'optional' => true,
  77                         'default'  => null,
  78                         'null'     => NULL_ALLOWED
  79                 ],
  80                 'shortcharvalue' => [
  81                         'type'     => PARAM_TEXT,
  82                         'optional' => true,
  83                         'default'  => null,
  84                         'null'     => NULL_ALLOWED
  85                 ],
  86                 // Mandatory field.
  87                 'value'          => [
  88                         'type'    => PARAM_RAW,
  89                         'null'    => NULL_NOT_ALLOWED,
  90                         'default' => ''
  91                 ],
  92                 // Mandatory field.
  93                 'valueformat'    => [
  94                         'type'    => PARAM_INT,
  95                         'null'    => NULL_NOT_ALLOWED,
  96                         'default' => FORMAT_MOODLE,
  97                         'optional' => true
  98                 ],
  99                 'valuetrust' => [
 100                     'type' => PARAM_BOOL,
 101                     'null' => NULL_NOT_ALLOWED,
 102                     'default' => false,
 103                     'optional' => true,
 104                 ],
 105                 'contextid'      => [
 106                         'type'     => PARAM_INT,
 107                         'optional' => false,
 108                         'null'     => NULL_NOT_ALLOWED
 109                 ]
 110         );
 111     }
 112
 113 }