Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 400 and 402] [Versions 401 and 402]

   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   * This file contains the definition for the renderable assign submission status.
  19   *
  20   * @package   mod_assign
  21   * @copyright 2020 Matt Porritt <mattp@catalyst-au.net>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_assign\output;
  25  
  26  /**
  27   * This file contains the definition for the renderable assign submission status.
  28   *
  29   * @package   mod_assign
  30   * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
  31   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class assign_submission_status implements \renderable {
  34      /** @var int STUDENT_VIEW */
  35      const STUDENT_VIEW     = 10;
  36      /** @var int GRADER_VIEW */
  37      const GRADER_VIEW      = 20;
  38  
  39      /** @var int allowsubmissionsfromdate */
  40      public $allowsubmissionsfromdate = 0;
  41      /** @var bool alwaysshowdescription */
  42      public $alwaysshowdescription = false;
  43      /** @var mixed the submission info (may be null or an integer) */
  44      public $submission = null;
  45      /** @var boolean teamsubmissionenabled - true or false */
  46      public $teamsubmissionenabled = false;
  47      /** @var \stdClass teamsubmission the team submission info (may be null) */
  48      public $teamsubmission = null;
  49      /** @var mixed submissiongroup the submission group info (may be null) */
  50      public $submissiongroup = null;
  51      /** @var array submissiongroupmemberswhoneedtosubmit list of users who still need to submit */
  52      public $submissiongroupmemberswhoneedtosubmit = array();
  53      /** @var bool submissionsenabled */
  54      public $submissionsenabled = false;
  55      /** @var bool locked */
  56      public $locked = false;
  57      /** @var bool graded */
  58      public $graded = false;
  59      /** @var int duedate */
  60      public $duedate = 0;
  61      /** @var int cutoffdate */
  62      public $cutoffdate = 0;
  63      /** @var array submissionplugins - the list of submission plugins */
  64      public $submissionplugins = array();
  65      /** @var string returnaction */
  66      public $returnaction = '';
  67      /** @var string returnparams */
  68      public $returnparams = array();
  69      /** @var int courseid */
  70      public $courseid = 0;
  71      /** @var int coursemoduleid */
  72      public $coursemoduleid = 0;
  73      /** @var int the view (STUDENT_VIEW OR GRADER_VIEW) */
  74      public $view = self::STUDENT_VIEW;
  75      /** @var bool canviewfullnames */
  76      public $canviewfullnames = false;
  77      /** @var bool canedit */
  78      public $canedit = false;
  79      /** @var bool cansubmit */
  80      public $cansubmit = false;
  81      /** @var int extensionduedate */
  82      public $extensionduedate = 0;
  83      /** @var \context context */
  84      public $context = 0;
  85      /** @var bool blindmarking - Should we hide student identities from graders? */
  86      public $blindmarking = false;
  87      /** @var string gradingcontrollerpreview */
  88      public $gradingcontrollerpreview = '';
  89      /** @var string attemptreopenmethod */
  90      public $attemptreopenmethod = 'none';
  91      /** @var int maxattempts */
  92      public $maxattempts = -1;
  93      /** @var string gradingstatus */
  94      public $gradingstatus = '';
  95      /** @var bool preventsubmissionnotingroup */
  96      public $preventsubmissionnotingroup = 0;
  97      /** @var array usergroups */
  98      public $usergroups = array();
  99      /** @var int The time limit for the assignment */
 100      public $timelimit = 0;
 101      /** @var bool */
 102      public $caneditowner;
 103  
 104      /**
 105       * Constructor
 106       *
 107       * @param int $allowsubmissionsfromdate
 108       * @param bool $alwaysshowdescription
 109       * @param mixed $submission
 110       * @param bool $teamsubmissionenabled
 111       * @param \stdClass $teamsubmission
 112       * @param mixed $submissiongroup
 113       * @param array $submissiongroupmemberswhoneedtosubmit
 114       * @param bool $submissionsenabled
 115       * @param bool $locked
 116       * @param bool $graded
 117       * @param int $duedate
 118       * @param int $cutoffdate
 119       * @param array $submissionplugins
 120       * @param string $returnaction
 121       * @param array $returnparams
 122       * @param int $coursemoduleid
 123       * @param int $courseid
 124       * @param string $view
 125       * @param bool $canedit
 126       * @param bool $cansubmit
 127       * @param bool $canviewfullnames
 128       * @param int $extensionduedate Any extension to the due date granted for this user.
 129       * @param \context $context Any extension to the due date granted for this user.
 130       * @param bool $blindmarking Should we hide student identities from graders?
 131       * @param string $gradingcontrollerpreview
 132       * @param string $attemptreopenmethod The method of reopening student attempts.
 133       * @param int $maxattempts How many attempts can a student make?
 134       * @param string $gradingstatus The submission status (ie. Graded, Not Released etc).
 135       * @param bool $preventsubmissionnotingroup Prevent submission if user is not in a group.
 136       * @param array $usergroups Array containing all groups the user is assigned to.
 137       * @param int $timelimit The time limit for the assignment.
 138       */
 139      public function __construct(
 140          $allowsubmissionsfromdate,
 141          $alwaysshowdescription,
 142          $submission,
 143          $teamsubmissionenabled,
 144          $teamsubmission,
 145          $submissiongroup,
 146          $submissiongroupmemberswhoneedtosubmit,
 147          $submissionsenabled,
 148          $locked,
 149          $graded,
 150          $duedate,
 151          $cutoffdate,
 152          $submissionplugins,
 153          $returnaction,
 154          $returnparams,
 155          $coursemoduleid,
 156          $courseid,
 157          $view,
 158          $canedit,
 159          $cansubmit,
 160          $canviewfullnames,
 161          $extensionduedate,
 162          $context,
 163          $blindmarking,
 164          $gradingcontrollerpreview,
 165          $attemptreopenmethod,
 166          $maxattempts,
 167          $gradingstatus,
 168          $preventsubmissionnotingroup,
 169          $usergroups,
 170          $timelimit
 171      ) {
 172          $this->allowsubmissionsfromdate = $allowsubmissionsfromdate;
 173          $this->alwaysshowdescription = $alwaysshowdescription;
 174          $this->submission = $submission;
 175          $this->teamsubmissionenabled = $teamsubmissionenabled;
 176          $this->teamsubmission = $teamsubmission;
 177          $this->submissiongroup = $submissiongroup;
 178          $this->submissiongroupmemberswhoneedtosubmit = $submissiongroupmemberswhoneedtosubmit;
 179          $this->submissionsenabled = $submissionsenabled;
 180          $this->locked = $locked;
 181          $this->graded = $graded;
 182          $this->duedate = $duedate;
 183          $this->cutoffdate = $cutoffdate;
 184          $this->submissionplugins = $submissionplugins;
 185          $this->returnaction = $returnaction;
 186          $this->returnparams = $returnparams;
 187          $this->coursemoduleid = $coursemoduleid;
 188          $this->courseid = $courseid;
 189          $this->view = $view;
 190          $this->canedit = $canedit;
 191          $this->cansubmit = $cansubmit;
 192          $this->canviewfullnames = $canviewfullnames;
 193          $this->extensionduedate = $extensionduedate;
 194          $this->context = $context;
 195          $this->blindmarking = $blindmarking;
 196          $this->gradingcontrollerpreview = $gradingcontrollerpreview;
 197          $this->attemptreopenmethod = $attemptreopenmethod;
 198          $this->maxattempts = $maxattempts;
 199          $this->gradingstatus = $gradingstatus;
 200          $this->preventsubmissionnotingroup = $preventsubmissionnotingroup;
 201          $this->usergroups = $usergroups;
 202          $this->timelimit = $timelimit;
 203      }
 204  }