panelizer_defaults_ui.class.php in Panelizer 7.3

Contains the administrative UI for selectable panelizer defaults.

File

plugins/export_ui/panelizer_defaults_ui.class.php

<?php

/**
 * @file
 * Contains the administrative UI for selectable panelizer defaults.
 */
class panelizer_defaults_ui extends ctools_export_ui {
  function init($plugin) {
    ctools_include('export');
    $this->plugin = $plugin;

    // Get rid of the list parent.
    unset($this->plugin['menu']['items']['list callback']);
  }
  function hook_menu(&$items) {

    // Change the item to a tab.
    $this->plugin['menu']['items']['list']['type'] = MENU_LOCAL_TASK;
    $this->plugin['menu']['items']['list']['weight'] = -6;
    $this->plugin['menu']['items']['list']['title'] = 'List defaults';

    // menu local actions are weird.
    $this->plugin['menu']['items']['add']['path'] = 'list/add';
    $this->plugin['menu']['items']['import']['path'] = 'list/import';

    // Edit is being handled elsewhere.
    unset($this->plugin['menu']['items']['edit callback']);
    unset($this->plugin['menu']['items']['access']);
    foreach (panelizer_operations() as $path => $operation) {
      $location = isset($operation['ui path']) ? $operation['ui path'] : $path;
      if (isset($this->plugin['menu']['items'][$location])) {
        unset($this->plugin['menu']['items'][$location]);
      }
    }

    // Change the callbacks for everything.
    foreach ($this->plugin['menu']['items'] as $key => $item) {

      // The item has already been set; continue to next item to avoid shifting
      // items onto the page arguments array more than once.
      if ($this->plugin['menu']['items'][$key]['access callback'] == 'panelizer_has_choice_callback') {
        continue;
      }
      $this->plugin['menu']['items'][$key]['access callback'] = 'panelizer_has_choice_callback';
      $this->plugin['menu']['items'][$key]['access arguments'] = array(
        3,
        4,
        '',
      );
      $this->plugin['menu']['items'][$key]['page callback'] = 'panelizer_export_ui_switcher_page';
      array_unshift($this->plugin['menu']['items'][$key]['page arguments'], 4);
      array_unshift($this->plugin['menu']['items'][$key]['page arguments'], 3);
    }
    parent::hook_menu($items);
  }
  function list_page($js, $input) {
    if ($substitute = $this->entity_handler
      ->get_substitute($this->entity_view_mode, $this->entity_bundle)) {
      $url = $this->plugin['menu']['menu prefix'] . '/' . $substitute;
      drupal_set_message(t('This display is managed by the !view_mode display.', array(
        '!view_mode' => l($substitute, $url),
      )), 'status', FALSE);
      return '';
    }
    drupal_set_title($this->entity_handler
      ->get_bundle_title($this->entity_bundle));
    return parent::list_page($js, $input);
  }
  function list_filter($form_state, $item) {

    // Reminder: This returns TRUE to exclude the item.
    if ($this->entity_handler->entity_type != $item->panelizer_type) {
      return TRUE;
    }
    if ($this->entity_bundle != $item->panelizer_key) {
      return TRUE;
    }
    if ($this->entity_view_mode != $item->view_mode) {
      return TRUE;
    }
    if (!$this->entity_handler
      ->access_default_panelizer_object($item)) {
      return TRUE;
    }
    if (empty($item->title) && $item->name == implode(':', array(
      $this->entity_handler->entity_type,
      $this->entity_bundle,
      'default',
    ))) {
      $item->title = t('Default');
    }
    return parent::list_filter($form_state, $item);
  }

  /**
   * Extends ctools_export_ui::edit_form().
   *
   * Change the 'exists' callback so that we can build the actual export object
   * name before checking if it exists.
   */
  function edit_form(&$form, &$form_state) {
    parent::edit_form($form, $form_state);
    foreach ($form['info'] as $export_key => $settings) {
      if (!empty($form['info'][$export_key]['#machine_name']['exists'])) {
        $form['info'][$export_key]['#machine_name']['exists'] = 'panelizer_defaults_ui_edit_name_exists';
      }
    }
  }
  function edit_execute_form_standard(&$form_state) {
    if ($form_state['form type'] == 'clone') {
      $form_state['item']->title = t('Clone of') . ' ' . $form_state['item']->title;
      $form_state['item']->name = '';
    }
    else {
      if ($form_state['op'] == 'add') {
        $form_state['item']->panelizer_type = $this->entity_handler->entity_type;
        $form_state['item']->panelizer_key = $this->entity_bundle;
        $form_state['item']->view_mode = $this->entity_view_mode;
        $form_state['item']->display = $this->entity_handler
          ->get_default_display($this->entity_bundle, $this->entity_view_mode);
      }
    }
    return parent::edit_execute_form_standard($form_state);
  }
  function edit_form_validate(&$form, &$form_state) {

    // Build the actual name of the object for ctools
    $export_key = $this->plugin['export']['key'];
    $name = panelizer_defaults_ui_build_export_name($form_state['values'][$export_key], $this);
    form_set_value($form['info'][$export_key], $name, $form_state);
  }

  // Simplest way to override the drupal_goto from parent.
  // Why isn't delete using the redirect system everything else is?
  function delete_page($js, $input, $item) {
    $clone = clone $item;

    // Change the name into the title so the form shows the right value.
    // @todo file a bug against CTools to use admin title if available.
    $clone->name = $clone->title;
    $form_state = array(
      'plugin' => $this->plugin,
      'object' => &$this,
      'ajax' => $js,
      'item' => $clone,
      'op' => $item->export_type & EXPORT_IN_CODE ? 'revert' : 'delete',
      'rerender' => TRUE,
      'no_redirect' => TRUE,
    );
    $output = drupal_build_form('ctools_export_ui_delete_confirm_form', $form_state);
    if (!empty($form_state['executed'])) {
      ctools_export_crud_delete($this->plugin['schema'], $item);
      $export_key = $this->plugin['export']['key'];
      drupal_set_message(t($this->plugin['strings']['confirmation'][$form_state['op']]['success'], array(
        '%title' => $item->title,
      )));
      drupal_goto(ctools_export_ui_plugin_base_path($this->plugin));
    }
    return $output;
  }

}

/**
 * Test for #machine_name type to see if an export exists.
 */
function panelizer_defaults_ui_edit_name_exists($name, $element, &$form_state) {
  $export_key = $form_state['plugin']['export']['key'];
  $name = panelizer_defaults_ui_build_export_name($form_state['values'][$export_key], $form_state['object']);

  // Pass it on to the original ctools function
  return ctools_export_ui_edit_name_exists($name, $element, $form_state);
}

/**
 * Build the actual name of the ctools export from a machine name.
 */
function panelizer_defaults_ui_build_export_name($machine_name, $object) {

  // When adding a machine name, the entity/bundle are left off so the user
  // does not have to deal with it. We put it back here behind the scenes.
  $name = implode(':', array(
    $object->entity_handler->entity_type,
    $object->entity_bundle,
    $machine_name,
  ));

  // The page_manager view mode is the pre-view mode support method; we have
  // to add this view mode as the name if it's a different view mode.
  if ($object->entity_view_mode != 'page_manager') {
    $name .= ':' . $object->entity_view_mode;
  }
  return $name;
}

Functions

Name	Description
panelizer_defaults_ui_build_export_name	Build the actual name of the ctools export from a machine name.
panelizer_defaults_ui_edit_name_exists	Test for #machine_name type to see if an export exists.

Classes

Name	Description
panelizer_defaults_ui	@file Contains the administrative UI for selectable panelizer defaults.