CourseReport.inc in Course 7.2

File

includes/CourseReport.inc

<?php

/**
 * Holds a user's total progress through a course and functionality to check
 * for completion of required objects.
 */
class CourseReport extends CourseHandler {

  /**
   * Get the course of this tracker.
   *
   * @return Course
   */
  public function getCourse() {
    return entity_load_single('course', $this->nid);
  }

  /**
   * Track the course (scan required objects, update progress, completion, etc).
   */
  public function track() {
    $required = 0;
    $required_complete = 0;
    $prev = NULL;
    $account = user_load($this->uid);
    $grades = [];
    foreach ($this
      ->getCourse()
      ->getObjects() as $courseObject) {
      if (!$courseObject
        ->isEnabled()) {
        continue;
      }
      if (!$prev) {
        $this
          ->setOption('section_name', $courseObject
          ->getTitle());
        $this
          ->setOption('coid', $courseObject
          ->getId());
      }

      // Count required objects.
      $required += $courseObject
        ->isRequired();

      // Count completed required objects.
      $required_complete += $courseObject
        ->isRequired() && $courseObject
        ->getFulfillment($account)
        ->isComplete();

      // Log last grade.
      if ($courseObject
        ->isGraded() && $courseObject
        ->getOption('grade_include')) {
        $grades[$courseObject
          ->identifier()] = $courseObject
          ->getFulfillment($account)
          ->getOption('grade_result');
      }
      if (!$courseObject
        ->getFulfillment($account)
        ->isComplete() && $prev && $prev
        ->getFulfillment($account)
        ->isComplete()) {
        $this
          ->setOption('section_name', $courseObject
          ->getTitle());
        $this
          ->setOption('coid', $courseObject
          ->getId());
      }
      $prev = clone $courseObject;
    }
    if (!empty($grades)) {
      $this
        ->setOption('grade_result', array_sum($grades) / count($grades));
    }
    if ($required_complete >= $required) {

      // Course requirements have been met.
      $this
        ->setOption('section', 'complete');
      $this
        ->setOption('section_name', 'Complete');
      $this
        ->setOption('complete', 1);
      if (!$this
        ->getOption('date_completed')) {
        $this
          ->setOption('date_completed', REQUEST_TIME);
      }
    }
    $this
      ->save();
  }

  /**
   * Course report entity label callback.
   */
  function defaultLabel() {
    $node = node_load($this->nid);
    $account = user_load($this->uid);
    return t("@username's course report for @title", array(
      '@username' => format_username($account),
      '@title' => $node->title,
    ));
  }
  function save() {
    $this->updated = REQUEST_TIME;
    return parent::save();
  }

  /**
   * If the course is complete for this record.
   *
   * @return bool
   */
  function isComplete() {
    return $this
      ->getOption('complete');
  }

}

Classes

Name	Description
CourseReport	Holds a user's total progress through a course and functionality to check for completion of required objects.