You are here

Home » API reference » Course 6 » course_quiz.classes.inc

class CourseObjectQuiz in Course 6

Same name and namespace in other branches
  1. 7.2 modules/course_quiz/course_quiz.classes.inc \CourseObjectQuiz
  2. 7 modules/course_quiz/course_quiz.classes.inc \CourseObjectQuiz

Hierarchy

Expanded class hierarchy of CourseObjectQuiz

1 string reference to 'CourseObjectQuiz'
course_quiz_course_handlers in modules/course_quiz/course_quiz.module
Implements hook_course_handlers().

File

modules/course_quiz/course_quiz.classes.inc, line 3

View source 
class CourseObjectQuiz extends CourseObjectNode {

  /**
   * Create the quiz node and set it as this object's instance.
   */
  function create() {
    $quiz = new stdClass();
    $quiz->auto_created = TRUE;
    $quiz->type = 'quiz';
    $quiz->title = $this
      ->getTitle();
    $quiz->uid = $this->user->uid;
    $quiz->quiz_always = TRUE;
    $quiz->quiz_open = $quiz->quiz_close = array(
      'month' => date('m'),
      'day' => date('d'),
      'year' => date('Y'),
    );
    $quiz = (object) array_merge(_quiz_get_node_defaults(), (array) $quiz);
    node_save($quiz);
    $this
      ->setNode($quiz);
  }

  /**
   * The take URL of the quiz is /take.
   */
  function getTakeUrl() {
    return url("node/{$this->node->nid}/take");
  }

  /**
   * Marks a user's fulfillment record for this object complete if the user
   * passed the quiz.
   */
  function grade($user, $rid) {
    $nid = (int) $this
      ->getInstanceId();
    $fulfillment = $this
      ->getFulfillment();
    $result_ids = (array) $fulfillment
      ->getOption('quiz_result_ids');
    $result_ids[] = $rid;
    $fulfillment
      ->setOption('quiz_result_ids', $result_ids);
    $result = reset(quiz_get_score_data(array(
      $nid,
    ), $user->uid));
    if ($result && $result->percent_score >= $this
      ->getOption('passing_grade')) {
      $fulfillment
        ->setGrade($result->percent_score)
        ->setComplete()
        ->save();
    }
    else {
      $fulfillment
        ->setGrade($result->percent_score)
        ->save();
    }
  }

  /**
   * Course quiz options.
   */
  public function optionsDefinition() {
    $options = parent::optionsDefinition();
    $options['passing_grade'] = 75;
    return $options;
  }

  /**
   * Add an option only pertinent to quiz?
   */
  public function optionsForm(&$form, &$form_state) {
    parent::optionsForm($form, $form_state);
    $defaults = $this
      ->getOptions();
    $form['grading']['passing_grade'] = array(
      '#title' => t('Passing grade'),
      '#type' => 'textfield',
      '#size' => 4,
      '#default_value' => $defaults['passing_grade'],
      '#description' => t('The user will not be able to proceed past this object unless this grade is met.'),
    );
  }

  /**
   * Let the user know if they have a Quiz without questions.
   */
  public function getWarnings() {
    $warnings = parent::getWarnings();
    if ($this
      ->getInstanceId()) {
      if (!quiz_get_number_of_questions($this->node->vid)) {
        $warnings[] = t('This Quiz does not have any questions. Please !link.', array(
          '!link' => l('add questions', "node/{$this->getInstanceId()}/questions"),
        ));
      }
    }
    return $warnings;
  }
  public function getReports() {
    return array(
      'results' => array(
        'title' => 'Results',
      ),
    );
  }
  public function getReport($key) {
    module_load_include('inc', 'quiz', 'quiz.admin');
    switch ($key) {
      case 'results':
        return array(
          'title' => t('Quiz results'),
          'content' => drupal_get_form('quiz_results_manage_results_form', $this->node),
        );
    }
  }

  /**
   * Remove all quiz attempts associated with this fulfillment.
   */
  public function unenroll() {
    parent::unenroll();
    $fulfillment = $this
      ->getFulfillment();
    quiz_delete_results((array) $fulfillment
      ->getOption('quiz_result_ids'));
  }
  function getNodeTypes() {
    return array(
      'quiz',
    );
  }
  function isGraded() {
    return TRUE;
  }
  function getCloneAbility() {
    return t('%object can only be partially cloned. It will be created with the same settings, but the without the questions', array(
      '%object' => $this
        ->getTitle(),
    ));
  }

  /**
   * Exception for quiz: we need to set auto_created.
   */
  function thaw($ice) {
    $this->node = $ice->node;
    unset($this->node->nid);
    $this->node->auto_created = TRUE;
    node_save($this->node);
    return $this->node->nid;
  }
  function getOptionsSummary() {
    $summary = parent::getOptionsSummary();
    if ($this
      ->getInstanceId()) {
      $summary['questions'] = l('Edit questions', "node/{$this->getInstanceId()}/questions");
    }
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CourseHandler::$accessMessages private property
CourseHandler::$config protected property
CourseHandler::$handlerType public property
CourseHandler::$primaryKey public property
CourseHandler::$serializedField public property
CourseHandler::$table public property
CourseHandler::addOptions final public function Merge an array of options onto the existing options.
CourseHandler::getAccessMessages public function Get an array of access messages.
CourseHandler::getDatabaseFields protected function Return an array of database fields. This determines what fields should be serialized instead of stored.
CourseHandler::getId function
CourseHandler::getOption final public function Get an option stored in this CourseObject.
CourseHandler::optionsMerge private function Merge arrays with replace, not append.
CourseHandler::setAccessMessage public function Set an access message to be displayed along with the course object when it is in the outline. For example, "This activity will open on XYZ" or "Please complete Step 1 to take this activity."
CourseHandler::setOption final public function Set an option for this handler.
CourseHandler::setOptions final public function Set this entire handler's options.
CourseObject::$course private property
CourseObject::$courseObjectFulfillment private property
CourseObject::$user protected property
CourseObject::access public function Access functionality for course objects.
CourseObject::getComponent function Get the object component for this course object.
CourseObject::getCourse function Get the Course that contains this CourseObject.
CourseObject::getCourseNid function Get the course node ID this CourseObject belongs to.
CourseObject::getFulfillment public function Get this course object's fulfillment object.
CourseObject::getInstanceId function Get the instance ID. This could be the external component ID, a Node ID...
CourseObject::getMaxOccurences public static function Return the number of occurances that can be in a course at the same time. For example, the design of the Certificate module can only have 1 set of mappings per node. The same goes for Course Credit. We may also want a course object that can only be… 2
CourseObject::getModule function Get the module that provides this course object.
CourseObject::getOptions public function Get options, with session options having precedence. Overrides CourseHandler::getOptions
CourseObject::getStatus public function Get the user's status in this course object. 1
CourseObject::getTitle function
CourseObject::getUrl public function Return the URL to the course object router.
CourseObject::hasPolling public function Specify whether fulfillment uses asynchronous polling. 2
CourseObject::isActive public function
CourseObject::isRequired public function Is this course object required for course completion?
CourseObject::isTemporary function Checks the temporary status of a course object.
CourseObject::optionFilter private function
CourseObject::overrideNavigation public function Override navigation links. 1
CourseObject::overrideOutlineListItem public function Overrides a course outline list item. 1
CourseObject::poll function Give the course object a chance do asynchronous polling and set completion on demand.
CourseObject::renderOptionsSummary public function Get all course object implementations of getOptionsSummary().
CourseObject::setComponent function Set the object component for this course object.
CourseObject::setCourse public function Set the Course for this CourseObject.
CourseObject::setId function Set the internal course object ID.
CourseObject::setInstanceId function Set this object's instance ID.
CourseObject::setModule function Set the module that provides this course object.
CourseObject::setUser function Set the user fulfilling/creating this course object.
CourseObject::take public function 5
CourseObject::takeCourseObject final public function Take a course object.
CourseObject::unEnroll function Remove any records associated with this course object for the user. 1
CourseObjectNode::$node protected property
CourseObjectNode::delete public function Destroy the node instance. Overrides CourseObject::delete
CourseObjectNode::freeze function Freeze data to persist over cloning/exporting. Overrides CourseObject::freeze
CourseObjectNode::getEditUrl public function Get the URL to edit this course object, if any. Overrides CourseObject::getEditUrl
CourseObjectNode::getTakeType public function Simple node course object behavior is to just redirect to the node. Overrides CourseObject::getTakeType 3
CourseObjectNode::grant function Grant access to course content before going to it. Overrides CourseObject::grant
CourseObjectNode::hasNodePrivacySupport public function
CourseObjectNode::optionsSubmit public function Save object configs to cache. Overrides CourseObject::optionsSubmit 2
CourseObjectNode::optionsValidate public function Validate the options form. Check the node type. Overrides CourseObject::optionsValidate
CourseObjectNode::revoke function Duration expired (or something) - CourseObject is telling us so. Overrides CourseObject::revoke
CourseObjectNode::save function On object write, set privacy on this node. Overrides CourseObject::save
CourseObjectNode::setNode public function Set the node and instance ID (node ID) of this CourseObjectNode.
CourseObjectNode::__construct public function Construct a course object from a database record. Overrides CourseObject::__construct
CourseObjectQuiz::create function Create the quiz node and set it as this object's instance. Overrides CourseObjectNode::create
CourseObjectQuiz::getCloneAbility function Returns an translated error message if this object has issues with cloning. Overrides CourseObjectNode::getCloneAbility
CourseObjectQuiz::getNodeTypes function Return a list of valid node types. Overrides CourseObjectNode::getNodeTypes
CourseObjectQuiz::getOptionsSummary function Get core options summary. Overrides CourseObject::getOptionsSummary
CourseObjectQuiz::getReport public function Let the course object provide its own reports. Overrides CourseObject::getReport
CourseObjectQuiz::getReports public function Let the course object provide its own reports. Overrides CourseObject::getReports
CourseObjectQuiz::getTakeUrl function The take URL of the quiz is /take. Overrides CourseObjectNode::getTakeUrl
CourseObjectQuiz::getWarnings public function Let the user know if they have a Quiz without questions. Overrides CourseObjectNode::getWarnings
CourseObjectQuiz::grade function Marks a user's fulfillment record for this object complete if the user passed the quiz.
CourseObjectQuiz::isGraded function Is this object graded? Overrides CourseObject::isGraded
CourseObjectQuiz::optionsDefinition public function Course quiz options. Overrides CourseObjectNode::optionsDefinition
CourseObjectQuiz::optionsForm public function Add an option only pertinent to quiz? Overrides CourseObjectNode::optionsForm
CourseObjectQuiz::thaw function Exception for quiz: we need to set auto_created. Overrides CourseObjectNode::thaw
CourseObjectQuiz::unenroll public function Remove all quiz attempts associated with this fulfillment.