You are here

class CourseObjectTest in Course 6

Same name and namespace in other branches
  1. 7.2 tests/course_test/course_test.classes.inc \CourseObjectTest
  2. 7 tests/course_test/course_test.classes.inc \CourseObjectTest

Dummy example course object.

Hierarchy

Expanded class hierarchy of CourseObjectTest

1 string reference to 'CourseObjectTest'
course_test_course_handlers in tests/course_test/course_test.module
Implements hook_course_handlers().

File

tests/course_test/course_test.classes.inc, line 6

View source
class CourseObjectTest extends CourseObject {
  public static function getMaxOccurences() {
    return 3;
  }

}

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::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::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::getStatus public function Get the user's status in this course object. 1
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::optionsDefinition public function Define configuration elements and their defaults. Overrides CourseHandler::optionsDefinition 3
CourseObject::optionsForm public function Default options form for all course objects. Overrides CourseHandler::optionsForm 3
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::take public function 5
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
CourseObjectTest::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… Overrides CourseObject::getMaxOccurences