author_pane.inc in Author Pane 7.2

File

plugins/content_types/author_pane.inc

<?php

/**
 * @file
 * This file provides a CTools content type containing the author pane.
 */
$plugin = array(
  'title' => t('Author Pane (content pane)'),
  'description' => t('Author related variables gathered from helper modules.'),
  'single' => TRUE,
  'required context' => new ctools_context_required(t('User'), 'user'),
  'category' => t('User'),
  'icon' => 'icon_user.png',
  'edit form' => 'author_pane_content_type_edit_form',
  'render callback' => 'author_pane_content_type_render',
  'admin title' => 'author_pane_content_type_admin_title',
  'defaults' => array(
    'caller' => 'advanced_profile',
    'picture_preset' => '',
    'join_date_type' => 'short',
  ),
);

/**
 * Output function for the 'author pane' content type.
 */
function author_pane_content_type_render($subtype, $conf, $panel_args, $context) {
  $account = isset($context->data) ? clone $context->data : NULL;
  $block = new stdClass();
  if ($account) {

    // Use the Real Name module if installed. Otherwise just the plain,
    // unthemed user name for the title since we don't want it linked.
    if (module_exists('realname')) {
      $block->title = theme('realname', $account, array(
        'plain' => TRUE,
      ));
    }
    else {
      $block->title = check_plain($account->name);
    }
    $variables = array(
      'account' => $account,
      'caller' => $conf['caller'],
      'picture_preset' => $conf['picture_preset'],
      'join_date_type' => $conf['join_date_type'],
    );
    $block->content = theme('author_pane', $variables);
  }
  else {
    $block->content = t('User information not available');
  }
  return $block;
}

/**
 * Returns an edit form for the custom type.
 */
function author_pane_content_type_edit_form($form, &$form_state) {
  $conf = $form_state['conf'];
  $join_date_options = array();
  foreach (system_get_date_types() as $date_type) {
    $join_date_options[$date_type['type']] = $date_type['title'];
  }
  $form['join_date_type'] = array(
    '#type' => 'select',
    '#title' => t('Join date, date type'),
    '#options' => $join_date_options,
    '#default_value' => $conf['join_date_type'],
    '#description' => t('Select which <a href="@date-type-url">date type</a> to use for displaying the join date.', array(
      '@date-type-url' => url('admin/config/regional/date-time'),
    )),
  );
  if (module_exists('image')) {
    $options = array(
      '' => '',
    );
    foreach (image_styles() as $style) {
      $options[$style['name']] = $style['name'];
    }
    $form['picture_preset'] = array(
      '#type' => 'select',
      '#title' => t('User picture preset'),
      '#options' => $options,
      '#description' => t('Imagecache preset to use for user picture. Leave blank to not use this feature.'),
      '#default_value' => $conf['picture_preset'],
    );
  }
  $form['caller'] = array(
    '#type' => 'textfield',
    '#title' => t('Caller'),
    '#size' => 50,
    '#description' => t('Name of the calling program. This can be picked up during the preprocessing for specific changes. If using this in Advanced Profile Kit, it should be set to "advanced_profile"'),
    '#default_value' => $conf['caller'],
  );
  return $form;
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function author_pane_content_type_edit_form_submit($form, &$form_state) {

  // Copy everything from our defaults.
  foreach (array_keys($form_state['plugin']['defaults']) as $key) {
    $form_state['conf'][$key] = $form_state['values'][$key];
  }
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function author_pane_content_type_admin_title($subtype, $conf, $context) {
  return t('"@s" author pane', array(
    '@s' => $context->identifier,
  ));
}

Functions

Name	Description
author_pane_content_type_admin_title	@todo Please document this function.
author_pane_content_type_edit_form	Returns an edit form for the custom type.
author_pane_content_type_edit_form_submit	@todo Please document this function.
author_pane_content_type_render	Output function for the 'author pane' content type.