crm_core_activity_view.inc in CRM Core 7

Handle the 'crm_core_activity view' override task.

This plugin overrides crm-core/activity/%crm_core_activity 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_activity/plugins/tasks/crm_core_activity_view.inc

View source

<?php

/**
 * @file
 * Handle the 'crm_core_activity view' override task.
 *
 * This plugin overrides crm-core/activity/%crm_core_activity 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.
 */

/**
 * Implements hook_page_manager_task_tasks().
 *
 * Specialized implementation of hook_page_manager_task_tasks().
 * See api-task.html for more information.
 */
function crm_core_activity_crm_core_activity_view_page_manager_tasks() {
  $text = 'When enabled, this overrides the default Drupal behavior for displaying activities at ' . '<em>crm-core/contact/%crm_core_contact/activities/%activity_id</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/activities/%activity_id.';
  $prefs = array(
    // This is a 'page' task and will fall under the page admin UI.
    'task type' => 'page',
    'title' => t('Activity template'),
    'admin title' => t('Activity template'),
    'admin description' => t($text),
    'admin path' => 'crm-core/contact/%crm_core_contact/activity/%crm_core_activity',
    // Menu hooks so that we can alter the crm-core/activity/%crm_core_activity menu entry to point to us.
    'hook menu' => 'crm_core_activity_crm_core_activity_view_menu',
    'hook menu alter' => 'crm_core_activity_crm_core_activity_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_activity_crm_core_activity_view_get_arguments',
    'get context placeholders' => 'crm_core_activity_crm_core_activity_view_get_contexts',
    // Allow this to be enabled or disabled:
    'disabled' => variable_get('page_manager_crm_core_activity_view_disabled', TRUE),
    'enable callback' => 'crm_core_activity_crm_core_activity_view_enable',
    'access callback' => 'crm_core_activity_crm_core_activity_view_access_check',
  );
  return $prefs;
}

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

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

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

/**
 * 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_activity_crm_core_activity_view_page($crm_core_activity) {

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

  // Load the crm_core_activity 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_activity->title);
  $uri = entity_uri('crm_core_activity', $crm_core_activity);

  // 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_activity,
  ));
  $output = ctools_context_handler_render($task, '', $contexts, array(
    $crm_core_activity->activity_id,
  ));
  if ($output != FALSE) {
    return $output;
  }
  $function = 'crm_core_activity_view';
  foreach (module_implements('page_manager_override') as $module) {
    $call = $module . '_page_manager_override';
    if (($rc = $call('crm_core_activity_view')) && function_exists($rc)) {
      $function = $rc;
      break;
    }
  }

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

/**
 * Callback to get arguments provided by this task handler.
 *
 * Since this is the crm_core_activity view and there is no UI on the arguments, we
 * create dummy arguments that contain the needed data.
 */
function crm_core_activity_crm_core_activity_view_get_arguments($task, $subtask_id) {
  return array(
    array(
      'keyword' => 'crm_core_activity',
      'identifier' => t('Activity being viewed'),
      'id' => 2,
      'name' => 'entity_id:crm_core_activity',
      'settings' => 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_activity_crm_core_activity_view_get_contexts($task, $subtask_id) {
  return ctools_context_get_placeholders_from_argument(crm_core_activity_crm_core_activity_view_get_arguments($task, $subtask_id));
}

/**
 * Callback to enable/disable the page from the UI.
 */
function crm_core_activity_crm_core_activity_view_enable($cache, $status) {
  variable_set('page_manager_crm_core_activity_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_activity_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 bool
 *   TRUE if the current user can access the page.
 */
function crm_core_activity_crm_core_activity_view_access_check($task, $subtask_id, $contexts) {
  $context = reset($contexts);
  return crm_core_activity_access('view', $context->data);
}

Functions

Name	Description
crm_core_activity_crm_core_activity_view_access_check	Callback to determine if a page is accessible.
crm_core_activity_crm_core_activity_view_enable	Callback to enable/disable the page from the UI.
crm_core_activity_crm_core_activity_view_get_arguments	Callback to get arguments provided by this task handler.
crm_core_activity_crm_core_activity_view_get_contexts	Callback to get context placeholders provided by this handler.
crm_core_activity_crm_core_activity_view_menu_alter	Callback defined by crm_core_contact_view_page_manager_tasks().
crm_core_activity_crm_core_activity_view_page	Entry point for our overridden crm_core_contact view.
crm_core_activity_crm_core_activity_view_page_manager_tasks	Implements hook_page_manager_task_tasks().

You are here

crm_core_activity_view.inc in CRM Core 7

File

Functions

API Navigation