nid.inc File Reference

(1.1.2.9 2008/07/29 09:37:24 sdboyer)

---

Detailed Description

Plugin to provide an argument handler for a node id

Plugin to provide an argument handler for a Node add form

Plugin to provide an argument handler for a Node edit form

Definition in file nid.inc.

Go to the source code of this file.

Functions
	panels_nid_choose_display ($conf, $context)
	panels_nid_context ($arg=NULL, $conf=NULL, $empty=FALSE)
	panels_nid_displays ($conf, $id)
	panels_nid_panels_arguments ()
	panels_nid_settings_form ($conf)
	panels_nid_settings_form_submit (&$values)

---

Function Documentation

panels_nid_choose_display	(	$	conf,
		$	context
	)

Based upon the settings and the context, choose which display to use.

Definition at line 145 of file nid.inc.

                                                    {
  if (empty($context->data)) {
    return;
  }

  if (!empty($conf['displays'][$context->data->type])) {
    return $context->data->type;
  }

  // Please note that 'default' is a special display.
  if (!empty($conf['own_default'])) {
    return 'default';
  }

  // Empty return says to use the default display.
  return;
}

panels_nid_context	(	$	arg = NULL,
		$	conf = NULL,
		$	empty = FALSE
	)

Discover if this argument gives us the node we crave.

Definition at line 28 of file nid.inc.

References panels_context_create(), and panels_context_create_empty().

                                                                       {
  // If unset it wants a generic, unfilled context.
  if ($empty) {
    return panels_context_create_empty('node', $conf);
  }

  if (!is_numeric($arg)) {
    return FALSE;
  }

  $node = node_load($arg);
  if (!$node) {
    return FALSE;
  }

  if (array_filter($conf['types']) && empty($conf['types'][$node->type])) {
    return FALSE;
  }

  return panels_context_create('node', $node, $conf);
}

Here is the call graph for this function:

panels_nid_displays	(	$	conf,
		$	id
	)

What additional displays does this argument provide?

Definition at line 115 of file nid.inc.

                                         {
  $displays = array();
  if (!empty($conf['own_default'])) {
    $displays['default'] = array(
      'title' => t('Node ID @id Default', array('@id' => $id)),
      'context' => 'node',
    );
  }

  if (is_array($conf['displays'])) {
    $options = array();
    foreach (node_get_types() as $type => $info) {
      $options[$type] = $info->name;
    }
    foreach (array_keys(array_filter($conf['displays'])) as $type) {
      $displays[$type] = array(
        'title' => t('Node ID @id @type', array('@id' => $id, '@type' => $options[$type])),
        // Tell it to base the template for this display off of the default.
        'default' => 'default',
        'context' => 'node',
      );
    }
  }

  return $displays;
}

panels_nid_panels_arguments

(

)

Definition at line 10 of file nid.inc.

                                       {
  $args['nid'] = array(
    'title' => t("Node ID"),
    // keyword to use for %substitution
    'keyword' => 'node',
    'description' => t('Restricts the argument to a node id.'),
    'context' => 'panels_nid_context',
    'settings form' => 'panels_nid_settings_form',
    'settings form submit' => 'panels_nid_settings_form_submit',
    'displays' => 'panels_nid_displays',
    'choose display' => 'panels_nid_choose_display',
  );
  return $args;
}

panels_nid_settings_form

(

$

conf

)

Settings form for the argument

Definition at line 53 of file nid.inc.

                                         {
  $options = array();
  foreach (node_get_types() as $type => $info) {
    $options[$type] = $info->name;
  }

  $form['types'] = array(
    '#title' => t('Node types'),
    '#type' => 'checkboxes',
    '#options' => $options,
    '#description' => t('You can restrict this argument to use the checked node types. Arguments from non-conforming node types will be ignored, and Panels will behave as if no argument were given. Leave all unchecked to impose no restriction.'),
    '#default_value' => $conf['types'],
    '#prefix' => '<div class="clear-block">',
    '#suffix' => '</div>',
  );

  $form['own_default'] = array(
    '#title' => t('Use different default display'),
    '#type' => 'checkbox',
    '#description' => t('If checked, when this argument is present it will use its own display rather than the default. Node types not selected in the "Own display" field will use this one.'),
    '#default_value' => $conf['own_default'],
  );

  $form['displays'] = array(
    '#title' => t('Own display'),
    '#type' => 'checkboxes',
    '#options' => $options,
    '#default_value' => $conf['displays'],
    '#description' => t('Each checked node type will get its own special display to layout its content. Only node types set above should be set here. Node types not set here will use the default display.'),
    '#prefix' => '<div class="clear-block">',
    '#suffix' => '</div>',
  );

  return $form;
}

panels_nid_settings_form_submit

(

&$

values

)

There appears to be a bit of a bug with the way we're handling forms; it causes 'checkboxes' to get invalid values added to them when empty. This takes care of that.

Definition at line 94 of file nid.inc.

                                                   {
  $types = node_get_types();
  if (!empty($values['types'])) {
    foreach ($values['types'] as $type => $value) {
      if (empty($types[$type])) {
        unset($values['types'][$type]);
      }
    }
  }
  if (!empty($values['displays'])) {
    foreach ($values['displays'] as $type => $value) {
      if (empty($types[$type])) {
        unset($values['displays'][$type]);
      }
    }
  }
}