contact_user.inc in Chaos Tool Suite (ctools) 7

File

page_manager/plugins/tasks/contact_user.inc

<?php

/**
 * @file
 */

/**
 * Specialized implementation of hook_page_manager_task_tasks(). See api-task.html for
 * more information.
 */
function page_manager_contact_user_page_manager_tasks() {
  if (!module_exists('contact')) {
    return;
  }
  return array(
    // This is a 'page' task and will fall under the page admin UI.
    'task type' => 'page',
    'title' => t('User contact'),
    'admin title' => t('User contact'),
    'admin description' => t('When enabled, this overrides the default Drupal behavior for displaying the user contact form at <em>user/%user/contact</em>. If no variant is selected, the default Drupal user contact form will be used.'),
    'admin path' => 'user/%user/contact',
    // Callback to add items to the page managertask administration form:
    'task admin' => 'page_manager_contact_user_task_admin',
    'hook menu alter' => 'page_manager_contact_user_menu_alter',
    // This is task uses 'context' handlers and must implement these to give the
    // handler data it needs.
    'handler type' => 'context',
    // handler type -- misnamed
    'get arguments' => 'page_manager_contact_user_get_arguments',
    'get context placeholders' => 'page_manager_contact_user_get_contexts',
    // Allow this to be enabled or disabled:
    'disabled' => variable_get('page_manager_contact_user_disabled', TRUE),
    'enable callback' => 'page_manager_contact_user_enable',
    'access callback' => 'page_manager_contact_user_access_check',
  );
}

/**
 * Callback defined by page_manager_contact_user_page_manager_tasks().
 *
 * Alter the user view input so that user view comes to us rather than the
 * normal user view process.
 */
function page_manager_contact_user_menu_alter(&$items, $task) {
  if (variable_get('page_manager_contact_user_disabled', TRUE)) {
    return;
  }
  $callback = $items['user/%user/contact']['page callback'];
  if ($callback == 'drupal_get_form') {
    $callback = $items['user/%user/contact']['page arguments'][0];
  }

  // Override the user view handler for our purpose.
  if ($callback == 'contact_personal_form' || variable_get('page_manager_override_anyway', FALSE)) {
    $items['user/%user/contact']['page callback'] = 'page_manager_contact_user';
    $items['user/%user/contact']['file path'] = $task['path'];
    $items['user/%user/contact']['file'] = $task['file'];
  }
  else {

    // Automatically disable this task if it cannot be enabled.
    variable_set('page_manager_contact_user_disabled', TRUE);
    if (!empty($GLOBALS['page_manager_enabling_contact_user'])) {
      drupal_set_message(t('Page manager module is unable to enable user/%user/contact because some other module already has overridden with %callback.', array(
        '%callback' => $callback,
      )), 'error');
    }
  }
}

/**
 * Entry point for our overridden user view.
 *
 * This function asks its assigned handlers who, if anyone, would like
 * to run with it. If no one does, it passes through to Drupal core's
 * user view, which is user_page_view().
 */
function page_manager_contact_user($form_id, $account) {

  // Load my task plugin:
  $task = page_manager_get_task('contact_user');

  // Load the account into a context.
  ctools_include('context');
  ctools_include('context-task-handler');
  $contexts = ctools_context_handler_get_task_contexts($task, '', array(
    $account,
  ));
  $output = ctools_context_handler_render($task, '', $contexts, array(
    $account->uid,
  ));
  if ($output !== FALSE) {
    return $output;
  }
  module_load_include('inc', 'contact', 'contact.pages');
  $function = 'contact_personal_form';
  foreach (module_implements('page_manager_override') as $module) {
    $call = $module . '_page_manager_override';
    if (($rc = $call('contact_user')) && function_exists($rc)) {
      $function = $rc;
      break;
    }
  }

  // Otherwise, fall back.
  return drupal_get_form($function, $account);
}

/**
 * Callback to get arguments provided by this task handler.
 *
 * Since this is the node view and there is no UI on the arguments, we
 * create dummy arguments that contain the needed data.
 */
function page_manager_contact_user_get_arguments($task, $subtask_id) {
  return array(
    array(
      'keyword' => 'user',
      'identifier' => t('User being viewed'),
      'id' => 1,
      'name' => 'uid',
      'settings' => array(),
    ),
  );
}

/**
 * Callback to get context placeholders provided by this handler.
 */
function page_manager_contact_user_get_contexts($task, $subtask_id) {
  return ctools_context_get_placeholders_from_argument(page_manager_contact_user_get_arguments($task, $subtask_id));
}

/**
 * Callback to enable/disable the page from the UI.
 */
function page_manager_contact_user_enable($cache, $status) {
  variable_set('page_manager_contact_user_disabled', $status);

  // Set a global flag so that the menu routine knows it needs
  // to set a message if enabling cannot be done.
  if (!$status) {
    $GLOBALS['page_manager_enabling_contact_user'] = TRUE;
  }
}

/**
 * Callback to determine if a page is accessible.
 *
 * @param $task
 *   The task plugin.
 * @param $subtask_id
 *   The subtask id
 * @param $contexts
 *   The contexts loaded for the task.
 *
 * @return
 *   TRUE if the current user can access the page.
 */
function page_manager_blog_contact_user_access_check($task, $subtask_id, $contexts) {
  $context = reset($contexts);
  return _contact_personal_tab_access($context->data);
}

Functions

Name	Description
page_manager_blog_contact_user_access_check	Callback to determine if a page is accessible.
page_manager_contact_user	Entry point for our overridden user view.
page_manager_contact_user_enable	Callback to enable/disable the page from the UI.
page_manager_contact_user_get_arguments	Callback to get arguments provided by this task handler.
page_manager_contact_user_get_contexts	Callback to get context placeholders provided by this handler.
page_manager_contact_user_menu_alter	Callback defined by page_manager_contact_user_page_manager_tasks().
page_manager_contact_user_page_manager_tasks	Specialized implementation of hook_page_manager_task_tasks(). See api-task.html for more information.