class CourseObjectBook in Course 7

Same name and namespace in other branches

6 modules/course_book/course_book.classes.inc \CourseObjectBook
7.2 modules/course_book/course_book.classes.inc \CourseObjectBook

Hierarchy

class \Entity implements EntityInterface
- class \CourseHandler
  - class \CourseObject
    class \CourseObjectNode
    class \CourseObjectBook

Expanded class hierarchy of CourseObjectBook

1 string reference to 'CourseObjectBook'

course_book_course_handlers in modules/course_book/course_book.module: Implements hook_course_handlers().

File

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

View source

class CourseObjectBook extends CourseObjectNode {

  /**
   * Course node context handler callback.
   */
  public static function getNodeInstances($node) {
    if (!empty($node->book['bid'])) {
      return array(
        $node->book['bid'],
      );
    }
  }
  function getNodeTypes() {
    if (user_access('administer book outlines')) {
      return array_keys(node_type_get_names());
    }
    else {
      return variable_get('book_allowed_types', array(
        'book',
      ));
    }
  }

  /**
   * Make the book.
   */
  public function create($node = NULL) {
    $node = new stdClass();
    $node->type = $this
      ->getOption('node_type');
    $node->book['bid'] = 'new';
    $node->book['mlid'] = NULL;
    parent::create($node);
  }
  function optionsDefinition() {
    $defaults = parent::optionsDefinition();
    $defaults['node_type'] = variable_get('course_book_default_node_type', 'book');
    $defaults['book_tracking'] = 'all';
    $defaults['outline_list_item_type'] = 'active_tree';
    return $defaults;
  }
  function optionsForm(&$form, &$form_state) {
    $config = $this
      ->getOptions();
    parent::optionsForm($form, $form_state);
    $form['book_tracking'] = array(
      '#title' => t('Completion criteria'),
      '#type' => 'select',
      '#options' => array(
        'one' => t('View any page'),
        'all' => t('View all pages'),
      ),
      '#default_value' => $config['book_tracking'],
    );

    // Add a book-specific configuration for course outline list item type, only
    // if the standard course list outline handler is selected.
    if ($this
      ->getCourse()
      ->getNode()->course['outline'] == 'course') {
      $form['outline_list_item_type'] = array(
        '#title' => t('Course outline list item type'),
        '#type' => 'select',
        '#options' => array(
          'all_pages' => t('All book pages as an expanded, nested list'),
          'active_tree' => t('Only the active book menu tree items, with a count indicator'),
          'count' => t('A count indicator only'),
        ),
        '#default_value' => $config['outline_list_item_type'],
      );
    }
    if (!module_exists('node_access_book')) {
      $form['node']['private']['#description'] .= '<br/><span style="color: #d00">If using "private", you should install <a href="http://drupal.org/project/node_access_book">Node access book</a> to ensure that book sub-pages obey the content access on the book parent.';
    }
  }

  /**
   * Grade (track) the book based on the fulfillment data.
   */
  function grade() {
    if (course_book_count($this->node->nid) == 0) {

      // Book has no pages. Complete object.
      $this
        ->getFulfillment()
        ->setComplete(1)
        ->save();
      return;
    }
    if ($this
      ->getOption('book_tracking') == 'all') {

      // Possibly a bug here. book_toc doesn't return inaccessible book pages.
      $mlids = array_keys(book_toc($this->node->nid, 99));
      $fulfillment = $this
        ->getFulfillment()
        ->getOption('book_fulfillment');
      $viewed = $fulfillment ? array_keys(array_filter($fulfillment)) : array();
      if (!array_diff($mlids, $viewed)) {
        $this
          ->getFulfillment()
          ->setComplete(1)
          ->save();
      }
    }
    elseif ($this
      ->getOption('book_tracking') == 'one') {
      $this
        ->getFulfillment()
        ->setComplete(1)
        ->save();
    }
  }

  /**
   * Overrides navigation links.
   */
  public function overrideNavigation() {
    $links = parent::overrideNavigation();
    $node = node_load(arg(1));
    if (isset($node->book)) {
      $book_link = $node->book;
      if ($prev = book_prev($book_link)) {
        $links['prev'] = l(t('Previous'), $prev['href']);
      }
      if ($next = book_next($book_link)) {
        $links['next'] = l(t('Next'), $next['href']);
      }
    }
    return $links;
  }

  /**
   * Overrides a course outline list item.
   */
  public function overrideOutlineListItem(&$item) {

    // Check that course list outline handler is selected.
    if ($this
      ->getCourse()
      ->getNode()->course['outline'] == 'course') {
      $type = $this
        ->getOption('outline_list_item_type');

      // Override the list item by reference.
      course_book_override_outline_list_item($item, $this, $type);
    }
  }
  public function getCloneAbility() {
    return t('%title will only clone the first page.', array(
      '%title' => $this
        ->getTitle(),
    ));
  }

  /**
   * Override of CourseObjectNode::save()
   *
   * We have to remove the stock "view" content access permissions on Books, if
   * node_access_book is enabled. Otherwise, users outside of the course can
   * still access child book pages of a private book parent.
   */
  public function save() {

    // Take care of the parent book page.
    parent::save();
    if ($this
      ->hasNodePrivacySupport() && $this
      ->getOption('private') && module_exists('node_access_book')) {

      // Remove "view" permissions on all the child pages.
      $flat = array();
      $tree = menu_tree_all_data($this->node->book['menu_name']);
      _book_flatten_menu($tree, $flat);
      foreach ($flat as $item) {
        $nid = str_replace('node/', '', $item['link_path']);
        $node = node_load($nid);
        $settings = content_access_get_per_node_settings($node);
        $settings['view'] = array();
        content_access_save_per_node_settings($node, $settings);

        // Resave node to update access.
        node_access_acquire_grants($node);
      }
    }
  }

  /**
   * Override of CourseObjectNode::freeze().
   *
   * Do not freeze the parent book ID.
   *
   * course_book_node_insert() stumbles if this is set and we are cloning a
   * book.
   */
  public function freeze() {
    $ice = parent::freeze();
    unset($ice->node->book['bid']);
    return $ice;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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	public	function	Get an handler option's value.
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	public	function	Set an option for this handler.
CourseHandler::setOptions	final public	function	Set this entire handler's options.
CourseObject::$accessMessages	protected	property
CourseObject::buildContent		function	Builds a structured array representing the entity's content. Overrides Entity::buildContent
CourseObject::getComponent		function	Get the object component for this course object.
CourseObject::getComponentName		function	Get the object component title 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 the user's fulfillment for this course 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, except weight, having precedence. Overrides CourseHandler::getOptions
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.	2
CourseObject::getUrl	public	function	Return the URL to the course object router.
CourseObject::getUser	public	function
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::isSkippable	public	function	If this course object is required, can be it skipped?
CourseObject::isTemporary		function	Checks the temporary status of a course object.
CourseObject::optionFilter	private	function
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::setDelete	public	function	Mark this object for deletion.
CourseObject::setId		function	Set the internal course object ID.
CourseObject::setModule		function	Set the module that provides this course object.
CourseObject::setUser	public	function
CourseObject::take	public	function		6
CourseObject::takeCourseObject	final public	function	Take a course object.
CourseObject::unEnroll		function	Remove any records associated with this course object for the user.	2
CourseObject::uri	public	function	Generate URI from course object. Overrides Entity::uri
CourseObjectBook::create	public	function	Make the book. Overrides CourseObjectNode::create
CourseObjectBook::freeze	public	function	Override of CourseObjectNode::freeze(). Overrides CourseObjectNode::freeze
CourseObjectBook::getCloneAbility	public	function	Returns an translated error message if this object has issues with cloning. Overrides CourseObjectNode::getCloneAbility
CourseObjectBook::getNodeInstances	public static	function	Course node context handler callback. Overrides CourseObjectNode::getNodeInstances
CourseObjectBook::getNodeTypes		function	Return a list of valid node types. Overrides CourseObjectNode::getNodeTypes
CourseObjectBook::grade		function	Grade (track) the book based on the fulfillment data.
CourseObjectBook::optionsDefinition		function	Define configuration elements and their defaults. Overrides CourseObjectNode::optionsDefinition
CourseObjectBook::optionsForm		function	Default options form for all course objects. Overrides CourseObjectNode::optionsForm
CourseObjectBook::overrideNavigation	public	function	Overrides navigation links. Overrides CourseObject::overrideNavigation
CourseObjectBook::overrideOutlineListItem	public	function	Overrides a course outline list item. Overrides CourseObject::overrideOutlineListItem
CourseObjectBook::save	public	function	Override of CourseObjectNode::save() Overrides CourseObjectNode::save
CourseObjectNode::$node	protected	property
CourseObjectNode::access		function	Deny access to objects without content. Overrides CourseObject::access
CourseObjectNode::context	public static	function	Course context handler callback. Overrides CourseObject::context
CourseObjectNode::delete	public	function	Destroy the node instance. Overrides CourseObject::delete
CourseObjectNode::getEditUrl	public	function	Get the URL to edit this course object, if any. Overrides CourseObject::getEditUrl
CourseObjectNode::getNode		function
CourseObjectNode::getOptionsSummary		function	Get core options summary. Overrides CourseObject::getOptionsSummary	2
CourseObjectNode::getTakeType	public	function	Simple node course object behavior is to just redirect to the node. Overrides CourseObject::getTakeType	3
CourseObjectNode::getTakeUrl	public	function	Get the URL to take this course object, if any. Overrides CourseObject::getTakeUrl	1
CourseObjectNode::getTitle		function	Get the object title, or return this object's node's title if the option is set. Overrides CourseObject::getTitle
CourseObjectNode::getViewUrl	public	function	Get the URL to view this course object, if any. Overrides CourseObject::getViewUrl
CourseObjectNode::getWarnings		function	Show a warning if this object has an instance, but the node does not exist. Overrides CourseHandler::getWarnings	2
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::setInstanceId		function	When setting our instance ID, also set the node. Overrides CourseObject::setInstanceId
CourseObjectNode::setNode	public	function	Set the node and instance ID (node ID) of this CourseObjectNode.
CourseObjectNode::thaw		function	Thaw data frozen from an earlier export/clone. Overrides CourseObject::thaw	3
CourseObjectNode::__construct	public	function	Overrides CourseHandler::__construct
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.

You are here

class CourseObjectBook in Course 7

Hierarchy

File

Members

API Navigation