class CourseObjectSignup in Course 6

Hierarchy

• class \CourseHandler
  • class \CourseObject
    • class \CourseObjectNode
      • class \CourseObjectSignup

1 string reference to 'CourseObjectSignup'

course_signup_course_handlers in modules/course_signup/course_signup.module

Implements hook_course_handlers().

File

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

class CourseObjectSignup extends CourseObjectNode {

  /**
   * Specify that this object needs a navigation listener.
   */
  public function hasPolling() {
    return TRUE;
  }
  public function create() {
    if (!$this
      ->getOption('instance')) {
      $this
        ->setOption('instance', $this
        ->getCourseNid());
    }
  }
  public function getTakeType() {
    return 'content';
  }
  public function take() {
    if ($this
      ->getFulfillment()
      ->isComplete()) {
      return "You have been marked attended by an administrator.";
    }
    else {
      return "You must be marked attended by an administrator.";
    }
  }
  public function optionsForm(&$form, &$form_state) {
    parent::optionsForm($form, $form_state);
    $form['node']['instance']['#title'] = t('Signup to check');
    $form['node']['instance']['#description'] .= ' ' . t('Node must be signup-enabled. Defaults to this course.');
  }

  /**
   * Set a specialized instance ID.
   *
   * Either the course node ID, or another signup node ID.
   */
  public function optionsSubmit(&$form, &$form_state) {
    if (!$form_state['values']['instance']) {
      $form_state['values']['instance'] = $this
        ->getCourseNid();
    }
    parent::optionsSubmit($form, $form_state);
  }
  public function getReports() {
    return array(
      'attendance' => array(
        'title' => 'Attendance',
      ),
    );
  }
  public function getReport($key) {
    module_load_include('inc', 'signup', 'includes/node_output');
    switch ($key) {
      case 'attendance':
        return array(
          'title' => t('Attendance'),
          'content' => t('These are the users who have enrolled in this course object.<br/>You may administer attendance on the !signups tab.', array(
            '!signups' => l('Signups', "node/{$this->node->nid}/signups"),
          )) . signup_user_list_output($this->node),
        );
    }
  }
  function getNodeTypes() {
    return signup_content_types();
  }
  function getCloneAbility() {
    return TRUE;
  }
  function thaw($ice) {

    // Not creating a new signup. Using this course.
    return $this
      ->getCourseNid();
  }

}

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::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::getOptionsSummary	public	function	Get core options summary. Overrides CourseHandler::getOptionsSummary	2
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::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::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::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::getTakeUrl	public	function	Get the URL to take this course object, if any. Overrides CourseObject::getTakeUrl	1
CourseObjectNode::getWarnings	public	function	Return a list of warning strings about this handler. Overrides CourseHandler::getWarnings	2
CourseObjectNode::grant		function	Grant access to course content before going to it. Overrides CourseObject::grant
CourseObjectNode::hasNodePrivacySupport	public	function
CourseObjectNode::optionsDefinition	public	function	Define configuration elements and their defaults. Overrides CourseObject::optionsDefinition	3
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
CourseObjectSignup::create	public	function	Creates a course object. Overrides CourseObjectNode::create
CourseObjectSignup::getCloneAbility		function	Returns an translated error message if this object has issues with cloning. Overrides CourseObjectNode::getCloneAbility
CourseObjectSignup::getNodeTypes		function	Return a list of valid node types. Overrides CourseObjectNode::getNodeTypes
CourseObjectSignup::getReport	public	function	Let the course object provide its own reports. Overrides CourseObject::getReport
CourseObjectSignup::getReports	public	function	Let the course object provide its own reports. Overrides CourseObject::getReports
CourseObjectSignup::getTakeType	public	function	Simple node course object behavior is to just redirect to the node. Overrides CourseObjectNode::getTakeType
CourseObjectSignup::hasPolling	public	function	Specify that this object needs a navigation listener. Overrides CourseObject::hasPolling
CourseObjectSignup::optionsForm	public	function	Default options form for all course objects. Overrides CourseObjectNode::optionsForm
CourseObjectSignup::optionsSubmit	public	function	Set a specialized instance ID. Overrides CourseObjectNode::optionsSubmit
CourseObjectSignup::take	public	function	Overrides CourseObject::take
CourseObjectSignup::thaw		function	Thaw data frozen from an earlier export/clone. Overrides CourseObjectNode::thaw