view.inc in CRM Core 8.2

Handle the 'crm_core_contact view' override task.

This plugin overrides crm-core/contact/%crm_core_contact and reroutes it to the page manager, where a list of tasks can be used to service this request based upon criteria supplied by access plugins.

File

modules/crm_core_contact/legacy/plugins/tasks/view.inc

<?php

/**
 * @file
 * Handle the 'crm_core_contact view' override task.
 *
 * This plugin overrides crm-core/contact/%crm_core_contact and reroutes it to the page manager, where
 * a list of tasks can be used to service this request based upon criteria
 * supplied by access plugins.
 */

/**
 * Specialized implementation of hook_page_manager_task_tasks(). See api-task.html for
 * more information.
 */
function crm_core_contact_view_page_manager_tasks() {
  return array(
    // This is a 'page' task and will fall under the page admin UI
    'task type' => 'page',
    'title' => t('Contact template'),
    'admin title' => t('Contact template'),
    'admin description' => t('When enabled, this overrides the default Drupal behavior for displaying contacts at <em>crm-core/contact/%crm_core_contact</em>. If you add variants, you may use selection criteria such as contact type or language or user access to provide different views of contacts. If no variant is selected, the default Drupal contact view will be used. This page only affects contacts viewed as pages, it will not affect contacts viewed in lists or at other locations. Also please note that if you are using pathauto, aliases may make a contact to be somewhere else, but as far as Drupal is concerned, they are still at crm-core/contact/%crm_core_contact.'),
    'admin path' => 'crm-core/contact/%crm_core_contact',
    // Menu hooks so that we can alter the crm-core/contact/%crm_core_contact menu entry to point to us.
    'hook menu' => 'crm_core_contact_view_menu',
    'hook menu alter' => 'crm_core_contact_view_menu_alter',
    // This is task uses 'context' handlers and must implement these to give the
    // handler data it needs.
    'handler type' => 'context',
    'get arguments' => 'crm_core_contact_view_get_arguments',
    'get context placeholders' => 'crm_core_contact_view_get_contexts',
    // Allow this to be enabled or disabled:
    'disabled' => variable_get('page_manager_crm_core_contact_view_disabled', TRUE),
    'enable callback' => 'crm_core_contact_view_enable',
    'access callback' => 'crm_core_contact_view_access_check',
  );
}

/**
 * Callback defined by crm_core_contact_view_page_manager_tasks().
 *
 * Alter the crm_core_contact view input so that crm_core_contact view comes to us rather than the
 * normal crm_core_contact view process.
 */
function crm_core_contact_view_menu_alter(&$items, $task) {
  if (variable_get('page_manager_crm_core_contact_view_disabled', TRUE)) {
    return;
  }

  // Override the crm_core_contact view handler for our purpose.
  $callback = $items['crm-core/contact/%crm_core_contact']['page callback'];
  if ($callback == 'crm_core_contact_view' || variable_get('page_manager_override_anyway', FALSE)) {
    $items['crm-core/contact/%crm_core_contact']['page callback'] = 'crm_core_contact_view_page';
    $items['crm-core/contact/%crm_core_contact']['file path'] = $task['path'];
    $items['crm-core/contact/%crm_core_contact']['file'] = $task['file'];
  }
  else {

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

  // @todo override crm_core_contact revision handler as well?
}

/**
 * Entry point for our overridden crm_core_contact 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
 * crm_core_contact view, which is crm_core_contact().
 */
function crm_core_contact_view_page($crm_core_contact) {

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

  // Load the crm_core_contact into a context.
  ctools_include('context');
  ctools_include('context-task-handler');

  // We need to mimic Drupal's behavior of setting the crm_core_contact title here.
  drupal_set_title(crm_core_contact_title($crm_core_contact));
  $uri = entity_uri('crm_core_contact', $crm_core_contact);

  // Set the crm_core_contact path as the canonical URL to prevent duplicate content.
  drupal_add_html_head_link(array(
    'rel' => 'canonical',
    'href' => url($uri['path'], $uri['options']),
  ), TRUE);

  // Set the non-aliased path as a default shortlink.
  drupal_add_html_head_link(array(
    'rel' => 'shortlink',
    'href' => url($uri['path'], array_merge($uri['options'], array(
      'alias' => TRUE,
    ))),
  ), TRUE);
  $contexts = ctools_context_handler_get_task_contexts($task, '', array(
    $crm_core_contact,
  ));
  $output = ctools_context_handler_render($task, '', $contexts, array(
    $crm_core_contact->contact_id,
  ));
  if ($output != FALSE) {
    return $output;
  }
  $function = 'crm_core_contact_view';
  foreach (module_implements('page_manager_override') as $module) {
    $call = $module . '_page_manager_override';
    if (($rc = $call('crm_core_contact_view')) && function_exists($rc)) {
      $function = $rc;
      break;
    }
  }

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

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

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

/**
 * Callback to enable/disable the page from the UI.
 */
function crm_core_contact_view_enable($cache, $status) {
  variable_set('page_manager_crm_core_contact_view_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_crm_core_contact_view'] = 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 crm_core_contact_view_access_check($task, $subtask_id, $contexts) {
  $context = reset($contexts);
  return crm_core_contact_access('view', $context->data);
}

Functions

Name	Description
crm_core_contact_view_access_check	Callback to determine if a page is accessible.
crm_core_contact_view_enable	Callback to enable/disable the page from the UI.
crm_core_contact_view_get_arguments	Callback to get arguments provided by this task handler.
crm_core_contact_view_get_contexts	Callback to get context placeholders provided by this handler.
crm_core_contact_view_menu_alter	Callback defined by crm_core_contact_view_page_manager_tasks().
crm_core_contact_view_page	Entry point for our overridden crm_core_contact view.
crm_core_contact_view_page_manager_tasks	Specialized implementation of hook_page_manager_task_tasks(). See api-task.html for more information.