class CourseObjectManual in Course 6

Hierarchy

• class \CourseHandler
  • class \CourseObject
    • class \CourseObjectManual

1 string reference to 'CourseObjectManual'

course_object_manual_course_handlers in modules/course_object_manual/course_object_manual.module

Implements hook_course_handlers().

File

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

class CourseObjectManual extends CourseObject {

  /**
   * Display status message as course content.
   */
  public function take() {
    return $this
      ->getStatus();
  }

  /**
   * Return a message about the user's status in this object, for when this
   * object is hidden.
   */
  public function getStatus() {
    $grade = $this
      ->getFulfillment()
      ->getGrade();
    $config = $this
      ->getOptions();
    if (!$this
      ->getFulfillment()
      ->getId()) {

      // User has not been given a status yet.
      return $config['incomplete_msg'];
    }
    if ($this
      ->getFulfillment()
      ->isComplete()) {

      // Complete. User given passed status.
      return $config['complete_msg'];
    }
    else {

      // User given a status but it wasn't complete. This means they failed.
      return $config['failed_msg'];
    }
  }
  public function optionsDefinition() {
    $defaults = parent::optionsDefinition();
    $defaults['complete_msg'] = 'Your instructor has marked you as passed.';
    $defaults['incomplete_msg'] = 'Your instructor has not given you a pass/fail grade yet.';
    $defaults['failed_msg'] = 'Your instructor has marked you as failed.';
    return $defaults;
  }
  public function optionsForm(&$form, &$form_state) {
    parent::optionsForm($form, $form_state);
    $config = $this
      ->getOptions();
    $form['complete_msg'] = array(
      '#type' => 'textfield',
      '#title' => 'Complete message',
      '#default_value' => $config['complete_msg'],
    );
    $form['failed_msg'] = array(
      '#type' => 'textfield',
      '#title' => 'Failed message',
      '#default_value' => $config['failed_msg'],
    );
    $form['incomplete_msg'] = array(
      '#type' => 'textfield',
      '#title' => 'Incomplete message',
      '#default_value' => $config['incomplete_msg'],
    );
  }

}

Members

Name	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::getWarnings	public	function	Return a list of warning strings about this handler.	1
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::create	public	function	Creates a course object.	1
CourseObject::delete	public	function	Deletes a course object's external resources.	1
CourseObject::freeze		function		1
CourseObject::getCloneAbility		function	Returns an translated error message if this object has issues with cloning.	2
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::getEditUrl	public	function	Get the URL to edit this course object, if any.	1
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::getOptionsSummary	public	function	Get core options summary. Overrides CourseHandler::getOptionsSummary	2
CourseObject::getReport		function	Let the course object provide its own reports.	4
CourseObject::getReports		function	Let the course object provide its own reports.	4
CourseObject::getTakeType	public	function	How should this course object be executed?	2
CourseObject::getTakeUrl	protected	function	Get the URL to take this course object, if any.	1
CourseObject::getTitle		function
CourseObject::getUrl	public	function	Return the URL to the course object router.
CourseObject::grant		function	Grant access to the external course object.	1
CourseObject::hasPolling	public	function	Specify whether fulfillment uses asynchronous polling.	2
CourseObject::isActive	public	function
CourseObject::isGraded		function	Is this object graded?	2
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::optionsSubmit	public	function	Save object configs to cache. Overrides CourseHandler::optionsSubmit	1
CourseObject::optionsValidate	public	function	Validate? Overrides CourseHandler::optionsValidate	1
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::revoke		function	Revoke access to the external course object.	1
CourseObject::save	public	function	Let objects create their instances before saving the course object. Overrides CourseHandler::save	1
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::takeCourseObject	final public	function	Take a course object.
CourseObject::thaw		function		1
CourseObject::unEnroll		function	Remove any records associated with this course object for the user.	1
CourseObject::__construct		function	Construct a course object from a database record. Overrides CourseHandler::__construct	1
CourseObjectManual::getStatus	public	function	Return a message about the user's status in this object, for when this object is hidden. Overrides CourseObject::getStatus
CourseObjectManual::optionsDefinition	public	function	Define configuration elements and their defaults. Overrides CourseObject::optionsDefinition
CourseObjectManual::optionsForm	public	function	Default options form for all course objects. Overrides CourseObject::optionsForm
CourseObjectManual::take	public	function	Display status message as course content. Overrides CourseObject::take