[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   * This file contains the comment class for the assignfeedback_editpdf plugin
  19   *
  20   * @package   assignfeedback_editpdf
  21   * @copyright 2012 Davo Smith
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace assignfeedback_editpdf;
  26  
  27  /**
  28   * This class represents a comment box on a page of feedback.
  29   * @copyright 2012 Davo Smith
  30   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class comment {
  33  
  34      /** @var int unique id for this annotation */
  35      public $id = 0;
  36  
  37      /** @var int gradeid for this annotation */
  38      public $gradeid = 0;
  39  
  40      /** @var int page number for this annotation */
  41      public $pageno = 0;
  42  
  43      /** @var int starting location in pixels. Image resolution is 100 pixels per inch */
  44      public $x = 0;
  45  
  46      /** @var int starting location in pixels. Image resolution is 100 pixels per inch */
  47      public $y = 0;
  48  
  49      /** @var int width of the comment box */
  50      public $width = 120;
  51  
  52      /** @var string The comment text. */
  53      public $rawtext = '';
  54  
  55      /** @var string colour - One of red, yellow, green, blue, white */
  56      public $colour = 'yellow';
  57  
  58      /**
  59       * Convert a compatible stdClass into an instance of a comment.
  60       * @param \stdClass $record
  61       */
  62      public function __construct(\stdClass $record = null) {
  63          if ($record) {
  64              $intcols = array('width', 'x', 'y');
  65              foreach ($this as $key => $value) {
  66                  if (isset($record->$key)) {
  67                      if (in_array($key, $intcols)) {
  68                          $this->$key = intval($record->$key);
  69                      } else {
  70                          $this->$key = $record->$key;
  71                      }
  72                  }
  73              }
  74          }
  75      }
  76  }