total_control.module in Total Control Admin Dashboard 6.2

File

total_control.module

<?php

/**
 * @file total_control.module
 *
 * This module enables an administrative dashboard.
 */
include_once 'includes/total_control.inc';
include_once 'includes/total_control.views_default.inc';
define('TOTAL_CONTROL_REQUIRED_PANELS_API', '3');
define('TOTAL_CONTROL_REQUIRED_VIEWS_API', '3');

// This is the name of the dashboard as the page manager module sees it via the page task.
define('TOTAL_CONTROL_DASHBOARD_PANEL_NAME', 'dashboard');
define('TOTAL_CONTROL_MINIMUM_VERSION', 1);
define('TOTAL_CONTROL_VERSION', 1);

/** 
 * Implementation of hook_perm().
 *
 * Adds permissions for access to the total control dashboard
 */
function total_control_perm() {
  return array(
    'have total control',
    'administer total control',
  );
}

/** 
 * Implementation of hook_menu().
 *
 * Adds the total control dashboard
 */
function total_control_menu() {
  $items = array();
  $items['admin/settings/control'] = array(
    'title' => 'Total Control',
    'description' => 'Adjust administration menu settings.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'total_control_admin_settings',
    ),
    'access arguments' => array(
      'administer total control',
    ),
    'file' => 'total_control.admin.inc',
  );
  return $items;
}

/**
 * Implementation of hook_form_alter().
 *
 * Adds views adjustment handling when content types are added or removed
 */
function total_control_form_alter(&$form, $form_state, $form_id) {
  if ('node_type_form' == $form_id) {
    $form['#submit'][] = 'total_control_add_type_submit';
  }
  if ('node_type_delete_confirm' == $form_id) {
    $form['#submit'][] = 'total_control_remove_type_submit';
  }
}

/**
 * Implementation of hook_ctools_plugin_api().
 *
 * Needed so that next hooks are picked up.
 */
function total_control_ctools_plugin_api($module, $api) {
  if ($module == 'page_manager' && $api == 'pages_default') {
    return array(
      'version' => 1,
    );
  }
}

/**
 * Implementation of hook_ctools_plugin_dierctory().
 *
 * Lets the system know we implement task and task_handler plugins.
 */
function total_control_ctools_plugin_directory($module, $plugin) {
  return 'plugins/' . $plugin;
}

/**
 * Implementation of hook_default_page_manager_handlers().
 */
function total_control_default_page_manager_handlers() {
  $handlers = array();
  include_once 'includes/total_control.default_page.inc';
  return $handlers;
}

/**
 * Implementation of hook_views_api().
 *
 * Register View API information. This is required for your module to have
 * its include files loaded; for example, when implementing
 * hook_views_default_views().
 *
 * @return
 *   An array with the following possible keys:
 *   - api:  (required) The version of the Views API the module implements.
 *   - path: (optional) If includes are stored somewhere other than within
 *       the root module directory or a subdirectory called includes, specify
 *       its path here.
 */
function total_control_views_api() {
  return array(
    'api' => 3,
  );
}

/**
 * Implementation of hook_user().
 *
 * Redirects to the dashboard if configured.
 */
function total_control_user($op, &$edit, &$account, $category = NULL) {
  if (!(arg(0) == 'user' && arg(1) == 'reset')) {
    if ($op == 'login' && (variable_get('total_control_login_redirect', 0) == 1 && user_access('have total control'))) {
      drupal_goto('admin/dashboard');
    }
  }
}

/**
 * Implementation of hook_views_pre_render().
 *
 * Adds the create content links to dashboard views.
 */
function total_control_views_pre_render(&$view) {

  // Check that this is the control content view
  if ($view->name == 'control_content') {

    // Get the content type for the current page.
    // Create an array to work with
    $type_displays = $view->display;
    unset($type_displays['default']);
    unset($type_displays['page_1']);
    $machine_names = array();
    foreach ($type_displays as $key => $value) {
      $machine_names[] = substr($key, 8);
    }

    /*
      // TODO
      foreach ($view->display as $display_id => $display) {

      }

      // Check for page.
      foreach ($machine_names as $type) {

        // Check if the user has access to create content of that type.
        if (user_access('create ' . $type . ' content')) {
          // Add the create content link.
          $add_link = l(t('Create ' . $type . ' content'), 'node/add/' . $type);
          if (array_key_exists('header', $view->display['page_tc_' . $type]->handler->options)) {
            // If there's already a header, append to it.
            $view->display['page_tc_' . $type]->handler->options['header'] .= $add_link;
          }
          else {
            // Otherwise add our own header.
            $view->display['page_tc_' . $type]->handler->options['header'] = $add_link;
          }
        }
      }
    */
  }
}

/**
 * Implementation of hook_theme().
 *
 * Adds theme functions for the output of content panes.
 */
function total_control_theme() {
  return array(
    'total_control_create' => array(
      'arguments' => array(
        'create' => array(),
      ),
      'file' => 'total_control.theme.inc',
    ),
    'total_control_overview' => array(
      'arguments' => array(
        'content' => array(),
        'users' => array(),
      ),
      'file' => 'total_control.theme.inc',
    ),
    'total_control_overview_content' => array(
      'arguments' => array(
        'overview' => array(),
      ),
      'file' => 'total_control.theme.inc',
    ),
    'total_control_overview_user' => array(
      'arguments' => array(
        'overview' => array(),
      ),
      'file' => 'total_control.theme.inc',
    ),
    'total_control_admin_table' => array(
      'arguments' => array(
        'header' => array(),
        'rows' => array(),
        'link' => FALSE,
      ),
      'file' => 'total_control.theme.inc',
    ),
  );
}

Functions

Name	Description
total_control_ctools_plugin_api	Implementation of hook_ctools_plugin_api().
total_control_ctools_plugin_directory	Implementation of hook_ctools_plugin_dierctory().
total_control_default_page_manager_handlers	Implementation of hook_default_page_manager_handlers().
total_control_form_alter	Implementation of hook_form_alter().
total_control_menu	Implementation of hook_menu().
total_control_perm	Implementation of hook_perm().
total_control_theme	Implementation of hook_theme().
total_control_user	Implementation of hook_user().
total_control_views_api	Implementation of hook_views_api().
total_control_views_pre_render	Implementation of hook_views_pre_render().

Constants

Name	Description
TOTAL_CONTROL_DASHBOARD_PANEL_NAME
TOTAL_CONTROL_MINIMUM_VERSION
TOTAL_CONTROL_REQUIRED_PANELS_API
TOTAL_CONTROL_REQUIRED_VIEWS_API
TOTAL_CONTROL_VERSION