book_parent.inc in Panels 5.2

relationships/book_parent.inc

Plugin to provide an relationship handler for book parent

File

relationships/book_parent.inc

<?php

/**
 * @file relationships/book_parent.inc
 *
 * Plugin to provide an relationship handler for book parent
 */
function panels_book_parent_panels_relationships() {
  $args['book_parent'] = array(
    'title' => t("Book parent"),
    'keyword' => 'book_parent',
    'description' => t('Adds a book parent from a node context.'),
    'required context' => new panels_required_context(t('Node'), 'node'),
    'context' => 'panels_book_parent_context',
    'settings form' => 'panels_book_parent_settings_form',
    'settings form validate' => 'panels_book_parent_settings_form_validate',
  );
  return $args;
}

/**
 * Return a new context based on an existing context
 */
function panels_book_parent_context($context = NULL, $conf) {

  // If unset it wants a generic, unfilled context, which is just NULL
  if (empty($context->data)) {
    return panels_context_create_empty('node');
  }
  if (isset($context->data->parent)) {
    if ($conf['type'] == 'top') {

      // Search through the book tree to load the top level.
      $result = array(
        'nid' => $context->data->nid,
        'vid' => $context->data->vid,
        'parent' => $context->data->parent,
      );
      while (!empty($result['parent'])) {
        $result = db_fetch_array(db_query("SELECT * FROM {book} b INNER JOIN {node} n ON b.vid = n.nid WHERE b.nid = %d", $result['parent']));
      }
      $nid = $result['nid'];
    }
    else {

      // Just load the parent book.
      $nid = $context->data->parent;
    }
    if (!empty($nid)) {

      // load the node
      $node = node_load($nid);

      // Generate the context.
      return panels_context_create('node', $node);
    }
  }
}

/**
 * Settings form for the relationship
 */
function panels_book_parent_settings_form($conf) {
  $form['type'] = array(
    '#type' => 'select',
    '#title' => t('Relationship type'),
    '#options' => array(
      'parent' => t('Immediate parent'),
      'top' => t('Top level book'),
    ),
    '#default_value' => $conf['type'],
  );
  return $form;
}

Functions

Name	Description
panels_book_parent_context	Return a new context based on an existing context
panels_book_parent_panels_relationships	@file relationships/book_parent.inc
panels_book_parent_settings_form	Settings form for the relationship