abstract class CourseObjectAccess in Course 6

Access handler for CourseObjects.

Subtypes must define take(), see(), and view().

Hierarchy

• class \CourseHandler
  • class \CourseObjectAccess

File

includes/course.core.inc, line 600

course.core.inc File for main Course class.

abstract class CourseObjectAccess extends CourseHandler {
  private $courseObject;
  function __construct($config = array()) {
    $this->handlerType = 'course_access';
    parent::__construct($config);
  }
  public function setCourseObject($courseObject) {
    $this->courseObject = $courseObject;
  }
  public function getCourseObject() {
    return $this->courseObject;
  }
  public abstract function take();
  public abstract function see();
  public abstract function view();

}

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::getOptions	public	function	Get an object's configuration.	1
CourseHandler::getOptionsSummary	public	function	Stub. Get the summary of an object's options.	1
CourseHandler::getWarnings	public	function	Return a list of warning strings about this handler.	1
CourseHandler::optionsDefinition	protected	function	Handlers need to declare their defaults if they have a configuration form.	4
CourseHandler::optionsForm	public	function	Handlers can declare a form.	4
CourseHandler::optionsMerge	private	function	Merge arrays with replace, not append.
CourseHandler::optionsSubmit	public	function	Save data somewhere.	1
CourseHandler::optionsValidate	public	function	Validate?	3
CourseHandler::save	public	function		2
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.
CourseObjectAccess::$courseObject	private	property
CourseObjectAccess::getCourseObject	public	function
CourseObjectAccess::see	abstract public	function		3
CourseObjectAccess::setCourseObject	public	function
CourseObjectAccess::take	abstract public	function		3
CourseObjectAccess::view	abstract public	function		3
CourseObjectAccess::__construct		function	Overrides CourseHandler::__construct