iassign/classes/event/course_module_viewed.php

<?php

/**
 * The mod_iassign course module viewed event.
 *
 * @author Patricia Alves Rodrigues
 * @author Leônidas O. Brandão
 * @version v 1.0 2015/07/12
 * @package mod_iassign
 * @since 2015/10/14
 * @copyright iMatica (<a href="http://www.matematica.br">iMath</a>) - Computer Science Dep. of IME-USP (Brazil)
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 
 */

namespace mod_iassign\event;

defined('MOODLE_INTERNAL') || die();

class course_module_viewed extends \core\event\course_module_viewed {

  /// Init method.
  protected function init () {
    $this->data['crud'] = 'r'; // c(reate), r(ead), u(pdate), d(elete)
    $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
    $this->data['objecttable'] = 'iassign';
    }

  /// Returns localised general event name.
  //  @return string
  public static function get_name () {
    return get_string('eventcoursemoduleviewed', 'mod_iassign');
    }

  /// Returns non-localised event description with id's for admin use only.
  //  @return string
  public function get_description () {
    return "The user with id '$this->userid' has viewed the iAssign with id '$this->objectid' in " .
           "the iAssign activity with course module id '$this->contextinstanceid'.";
    }

  /// Get URL related to the action.
  //  @return \moodle_url
  public function get_url () {
    return new \moodle_url('/mod/iassign/view.php', array('id' => $this->contextinstanceid));
    }

  /// Return the legacy event log data.
  //  @return array|null
  public function get_legacy_logdata () {
    return array($this->courseid, 'iassign', 'view', "view.php?id={$this->contextinstanceid}", $this->objectid, $this->contextinstanceid);
    }

  /// Custom validation.
  //  @throws \coding_exception
  //  @return void
  protected function validate_data () {
    parent::validate_data();
    // Make sure this class is never used without proper object details.
    if(!$this->contextlevel === CONTEXT_MODULE) {
      throw new \coding_exception('Context level must be CONTEXT_MODULE.');
      }
    }

  }