overview_user.inc in Total Control Admin Dashboard 6.2

overview_user.inc

"User overview" content type. Displays a summary of user statistics including: number of total users, active users, blocked users, and users in each role.

File

plugins/content_types/overview_user.inc

<?php

/**
 * @file overview_user.inc
 *
 * "User overview" content type. Displays a summary of user statistics 
 * including: number of total users, active users, blocked users, and 
 * users in each role.
 *
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
$plugin = array(
  'title' => t('Overview - User accounts'),
  'description' => t('Displays a summary of user statistics including: number 
    of total users, active users, blocked users, and users in each role.'),
  // 'single' => TRUE means has no subtypes.
  'single' => TRUE,
  // Constructor.
  'content_types' => array(
    'total_control_overview_user_content_type',
  ),
  // Name of a function which will render the block.
  'render callback' => 'total_control_overview_user_content_type_render',
  // The default context.
  'defaults' => array(
    'user' => NULL,
    'roles' => NULL,
  ),
  // This explicitly declares the config form. Without this line, the func would be
  // total_control_overview_user_content_type_edit_form.
  'edit form' => 'total_control_overview_user_content_type_edit_form',
  // Icon goes in the directory with the content type.
  'icon' => 'icon_node_form.png',
  'category' => t('Dashboard'),
);

/**
 * 'Admin title' callback for the content type.
 */
function total_control_overview_user_content_type_admin_title($subtype = NULL, $conf = NULL, $context = NULL) {
  return t('Overview of user accounts');
}

/**
 * 'Admin info' callback for the content type.
 */
function total_control_overview_user_content_type_admin_info($subtype, $conf, $context) {
  $block = new stdClass();
  $block->title = t('Displays a summary of user statistics including: number
    of total users, active users, blocked users, and users in each role.');
  return $block;
}

/**
 * Run-time rendering of the body of the block.
 *
 * @param $subtype
 * @param $conf
 *   Configuration as done at admin time.
 * @param $args
 * @param $context
 *   Context - in this case we don't have any.
 *
 * @return
 *   An object with at least title and content members.
 */
function total_control_overview_user_content_type_render($subtype, $conf, $panel_args, &$context) {
  $block = new stdClass();
  $block->module = t('total_control');
  $block->title = t('Overview of user accounts');
  $overview = total_control_get_user_overview($conf);
  $block->content = theme('total_control_overview_user', $overview);
  return $block;
}

/**
 * 'Edit form' callback for the content type.
 */
function total_control_overview_user_content_type_edit_form(&$form, &$form_state) {
  $conf = $form_state['conf'];
  total_control_add_user_pane_settings($form, $form_state);
  return $form;
}

/**
 * 'Edit form' submit callback for the content type.
 */
function total_control_overview_user_content_type_edit_form_submit(&$form, &$form_state) {
  foreach (array_keys($form_state['plugin']['defaults']) as $key) {
    $form_state['conf'][$key] = $form_state['values'][$key];
  }
}

Functions

Name	Description
total_control_overview_user_content_type_admin_info	'Admin info' callback for the content type.
total_control_overview_user_content_type_admin_title	'Admin title' callback for the content type.
total_control_overview_user_content_type_edit_form	'Edit form' callback for the content type.
total_control_overview_user_content_type_edit_form_submit	'Edit form' submit callback for the content type.
total_control_overview_user_content_type_render	Run-time rendering of the body of the block.