panels_node_content.module in Panels 6.2

panels_node_content.module

This module exposes nodes directly to the add content interface. The context system provided by the main panel module is a much more powerful replacement for this simple, yet deprecated method.

File

panels_node_content/panels_node_content.module

<?php

/**
 * @file panels_node_content.module
 *
 * This module exposes nodes directly to the add content interface.
 * The context system provided by the main panel module is a much more powerful
 * replacement for this simple, yet deprecated method.
 */

/**
 * Implementation of hook_menu().
 */
function panels_node_content_menu() {
  $items['admin/panels/node-content'] = array(
    'title' => 'Node panes',
    'access arguments' => array(
      'access administration pages',
    ),
    'type' => MENU_NORMAL_ITEM,
    'page callback' => 'panels_node_content_admin',
    'description' => 'Information about the content node content type.',
  );
  return $items;
}

/**
 * Page callback for the very short admin page.
 */
function panels_node_content_admin() {
  $output = '<p>';
  $output .= t('Panels node panes does not have a normal administrative UI, such as panels pages or mini panels. With this module, users may add a node directly to a panel via the add content interface. They may then select this node using an auto-complete field. In general, this method of adding nodes to panes should be considered deprecated (especially by module developers implementing the Panels API) and is only retained to support updating sites that use this older method. Moving forward, it is recommended that the context system be used to embed nodes, as that is far more powerful and interesting.');
  $output .= t('However, certain modules which make use of Panels are dependent on this method of getting node context (often without the developer even being aware of it), so it is important to emphasize that you CAN leave this module enabled without negatively impacting your site.');
  $output .= '</p>';
  return $output;
}

/**
 * Implementation of hook_panels_content_types()
 */
function panels_node_panels_content_types() {
  $items['node'] = array(
    'title' => t('Node'),
    'weight' => -10,
    'single' => TRUE,
    'content_types' => 'panels_node_content_content_types',
    'render callback' => 'panels_node_content_render',
    'add callback' => 'panels_node_content_add',
    'edit callback' => 'panels_node_content_edit',
    'title callback' => 'panels_node_content_title',
    'add validate callback' => 'panels_node_content_edit_validate',
    'edit validate callback' => 'panels_node_content_edit_validate',
  );
  return $items;
}

/**
 * Output function for the 'node' content type.
 *
 * Outputs a node based on the module and delta supplied in the configuration.
 */
function panels_node_content_render($subtype, $conf, $panel_args) {
  $nid = $conf['nid'];
  $block = new stdClass();
  foreach (explode('/', $_GET['q']) as $id => $arg) {
    $nid = str_replace("%{$id}", $arg, $nid);
  }
  foreach ($panel_args as $id => $arg) {
    $nid = str_replace("@{$id}", $arg, $nid);
  }

  // Support node translation
  if (module_exists('translation')) {
    if ($translations = module_invoke('translation', 'node_get_translations', $nid)) {
      if ($translations[$GLOBALS['language']->language]) {
        $nid = $translations[$GLOBALS['language']->language]->nid;
      }
    }
  }
  if (!is_numeric($nid)) {
    return;
  }
  $node = node_load($nid);
  if (!node_access('view', $node)) {
    return;
  }
  if (node_access('update', $node)) {
    $block->admin_links['update'] = array(
      'title' => t('Edit node'),
      'alt' => t("Edit this node"),
      'href' => "node/{$node->nid}/edit",
      'query' => drupal_get_destination(),
    );
  }
  $block->module = 'node';
  $block->delta = $node->nid;
  $block->subject = $node->title;
  if (empty($conf['leave_node_title'])) {
    unset($node->title);
  }
  if (!empty($conf['identifier'])) {
    $node->panel_identifier = $conf['identifier'];
  }
  $block->content = node_view($node, $conf['teaser'], FALSE, $conf['links']);
  return $block;
}

/**
 * Return all content types available.
 */
function panels_node_content_content_types() {
  return array(
    'node' => array(
      'title' => t('Node content'),
      'icon' => 'icon_node.png',
      'description' => t('Add a node from your site as content.'),
      'category' => array(
        t('Custom'),
        -10,
      ),
    ),
  );
}

/**
 * Returns the form for a new node.
 */
function panels_node_content_add($id, $parents, $conf = array()) {
  $form = panels_node_content_edit($id, $parents, $conf);
  $form['nid'] = array(
    '#prefix' => '<div class="no-float">',
    '#suffix' => '</div>',
    '#title' => t('Enter the title or NID of a post'),
    '#description' => t('To use a NID from the URL, you may use %0, %1, ..., %N to get URL arguments. Or use @0, @1, @2, ..., @N to use arguments passed into the panel.'),
    '#type' => 'textfield',
    '#maxlength' => 512,
    '#autocomplete_path' => 'panels/node/autocomplete',
    '#weight' => -10,
  );
  $form['validate_me'] = array(
    '#type' => 'value',
    '#value' => TRUE,
  );
  return $form;
}

/**
 * Returns an edit form for the custom type.
 */
function panels_node_content_edit($id, $parents, $conf) {
  $form['nid'] = array(
    '#type' => 'value',
    '#default_value' => $conf['nid'],
  );
  $form['teaser'] = array(
    '#title' => t('Teaser'),
    '#type' => 'checkbox',
    '#default_value' => $conf['teaser'],
    '#description' => t('Check here to show only the node teaser'),
  );
  $form['links'] = array(
    '#type' => 'checkbox',
    '#default_value' => $conf['links'],
    '#title' => t('Display links'),
    '#description' => t('Check here to display the links with the post.'),
  );
  $form['leave_node_title'] = array(
    '#type' => 'checkbox',
    '#default_value' => $conf['leave_node_title'],
    '#title' => t('Leave node title'),
    '#description' => t('Advanced: if checked, do not touch the node title; this can cause the node title to appear twice unless your theme is aware of this.'),
  );
  $form['identifier'] = array(
    '#type' => 'textfield',
    '#default_value' => $conf['identifier'],
    '#title' => t('Identifier'),
    '#description' => t('Whatever is placed here will appear in $node->panel_identifier to make it easier to theme a node or part of a node as necessary.'),
  );
  return $form;
}

/**
 * Validate a node.
 */
function panels_node_content_edit_validate($form, &$form_state) {
  if (!$form_state['values']['validate_me']) {
    return;
  }
  $nid = $form_state['values']['nid'];
  $preg_matches = array();
  $match = preg_match('/\\[nid: (\\d+)\\]/', $nid, $preg_matches);
  if (!$match) {
    $match = preg_match('/^nid: (\\d+)/', $nid, $preg_matches);
  }
  if ($match) {
    $nid = $preg_matches[1];
  }
  if (is_numeric($nid)) {
    $node = db_fetch_object(db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d"), $nid));
  }
  else {
    $node = db_fetch_object(db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE LOWER(n.title) = LOWER('%s')"), $nid));
  }
  if ($node) {
    $form_state['values']['nid'] = $node->nid;
  }
  if (!($node || preg_match('/^[@%]\\d+$/', $nid))) {
    form_error($form['nid'], t('Invalid node'));
  }
}

/**
 * Returns the administrative title for a node.
 */
function panels_node_content_title($subtype, $conf) {
  if (!is_numeric($conf['nid'])) {
    return t('Node loaded from @var', array(
      '@var' => $conf['nid'],
    ));
  }
  $node = node_load($conf['nid']);
  if ($node) {
    return check_plain($node->title);
  }
  else {
    return t('Deleted/missing node @nid', array(
      '@nid' => $conf['nid'],
    ));
  }
}

Functions

Name	Description
panels_node_content_add	Returns the form for a new node.
panels_node_content_admin	Page callback for the very short admin page.
panels_node_content_content_types	Return all content types available.
panels_node_content_edit	Returns an edit form for the custom type.
panels_node_content_edit_validate	Validate a node.
panels_node_content_menu	Implementation of hook_menu().
panels_node_content_render	Output function for the 'node' content type.
panels_node_content_title	Returns the administrative title for a node.
panels_node_panels_content_types	Implementation of hook_panels_content_types()