custom_formatters.inc in Custom Formatters 7.2

CTools Export UI plugin for SexyBookmarks profiles.

File

plugins/export_ui/custom_formatters.inc

<?php

/**
 * @file
 * CTools Export UI plugin for SexyBookmarks profiles.
 */

/**
 * CTools Export UI required function for plugin definition.
 */
function custom_formatters_custom_formatters_ctools_export_ui() {
  return array(
    'schema' => 'formatters',
    'access' => 'administer custom formatters',
    'menu' => array(
      'menu prefix' => 'admin/structure',
      'menu item' => 'formatters',
      'menu title' => 'Formatters',
      'menu description' => 'Administer Formatters.',
    ),
    'title singular' => t('formatter'),
    'title singular proper' => t('Formatter'),
    'title plural' => t('formatters'),
    'title plural proper' => t('Formatters'),
    'handler' => 'custom_formatters_ui',
    'form' => array(
      'settings' => 'custom_formatters_export_ui_form',
      'submit' => 'custom_formatters_export_ui_form_submit',
    ),
    'export' => array(
      'admin_title' => 'label',
      'admin_description' => 'description',
    ),
  );
}

/**
 * Custom Formatters settings form.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 */
function custom_formatters_export_ui_form(&$form, &$form_state) {
  $form['#attached'] = array(
    'css' => array(
      drupal_get_path('module', 'custom_formatters') . '/styles/custom_formatters.css',
    ),
    'js' => array(
      drupal_get_path('module', 'custom_formatters') . '/scripts/custom_formatters.admin.js',
    ),
  );
  $item = $form_state['item'];
  $form['#item'] = $item;
  $form['#formatters'] = TRUE;
  $engines = module_invoke_all('custom_formatters_engine_info');
  $engine = !empty($form_state['values']['mode']) ? $form_state['values']['mode'] : (!empty($item->mode) ? $item->mode : key($engines));
  if (isset($engines[$engine]['file']) && file_exists($engines[$engine]['file'])) {
    require_once $engines[$engine]['file'];
  }
  $disable = FALSE;
  if ($form_state['op'] != 'add') {
    $disable = custom_formatters_formatter_is_active($item);
    if ($disable) {
      drupal_set_message(t('As the Formatter is currently in use, certain features have been disabled.'), 'warning');
    }
  }
  $form['info']['#title'] = t('Basic information');
  $form['info']['#type'] = 'fieldset';
  $form['info']['#collapsible'] = TRUE;
  $form['info']['#collapsed'] = $form_state['op'] != 'add';
  $form['info']['label']['#title'] = t('Formatter name');
  $form['info']['label']['#required'] = TRUE;
  $form['info']['description'] = array(
    '#title' => t('Description'),
    '#type' => 'textarea',
    '#default_value' => $item->description,
  );
  $options = array();
  foreach ($engines as $key => $option) {
    $options[$key] = $option['label'];
  }
  $form['info']['mode'] = array(
    '#title' => t('Format'),
    '#type' => 'select',
    '#options' => $options,
    '#default_value' => $engine,
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js',
      'wrapper' => 'engine-wrapper',
    ),
  );
  $form['engine'] = array(
    '#type' => 'container',
    '#prefix' => '<div id="engine-wrapper">',
    '#suffix' => '</div>',
  );

  // Build list of available field types.
  $options = array();
  $fields = field_info_field_types();

  // Give modules a chance to alter fields.
  drupal_alter('custom_formatters_fields', $fields);
  ksort($fields);
  foreach ($fields as $type => $field) {
    $options[$field['module']][$type] = $field['label'];
  }
  ksort($options);
  $form['engine']['field_types'] = array(
    '#title' => t('Field type(s)'),
    '#type' => 'select',
    '#options' => $options,
    '#default_value' => $item->field_types,
    '#required' => TRUE,
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js',
      'wrapper' => 'engine-wrapper',
    ),
    '#disabled' => $disable,
  );
  $form['engine']['code'] = array(
    '#title' => t('Formatter'),
    '#type' => 'textarea',
    '#default_value' => !empty($item->code) ? $item->code : '',
    '#required' => TRUE,
    '#rows' => 10,
  );
  $options = _custom_formatters_preview_variables($form, $form_state);
  $form['engine']['preview'] = array(
    '#title' => t('Preview'),
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 100,
    '#theme' => 'custom_formatters_export_ui_form_preview',
    '#tree' => TRUE,
  );
  $form['engine']['preview']['entity_type'] = array(
    '#title' => t('Entity type'),
    '#type' => 'select',
    '#options' => $options['entity_types'],
    '#default_value' => 'node',
    '#disabled' => empty($options['entity_types']),
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js',
      'wrapper' => 'engine-wrapper',
    ),
  );
  $form['engine']['preview']['bundle'] = array(
    '#title' => t('Bundle'),
    '#type' => 'select',
    '#options' => $options['bundles'],
    '#disabled' => empty($options['bundles']),
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js',
      'wrapper' => 'engine-wrapper',
    ),
  );
  $form['engine']['preview']['field'] = array(
    '#title' => t('Field'),
    '#type' => 'select',
    '#options' => $options['fields'],
    '#disabled' => empty($options['fields']),
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js',
      'wrapper' => 'engine-wrapper',
    ),
  );
  $form['engine']['preview']['entity'] = array(
    '#title' => t('Entity'),
    '#type' => 'select',
    '#options' => $options['entities'],
    '#disabled' => empty($options['entities']),
  );
  $form['engine']['preview']['options'] = array(
    '#type' => 'container',
  );
  $form['engine']['preview']['button'] = array(
    '#type' => 'button',
    '#value' => t('Preview'),
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_form_js_preview',
      'wrapper' => 'preview-wrapper',
    ),
    '#disabled' => empty($options['entities']),
  );
  $form['engine']['preview']['preview'] = array(
    '#type' => 'container',
    '#prefix' => '<div id="preview-wrapper">',
    '#suffix' => '</div>',
  );
  $engines[$engine]['callbacks']['settings form']($form['engine'], $form_state, $item);
  $form['buttons']['edit'] = array(
    '#type' => 'submit',
    '#value' => t('Save & Edit'),
  );
}

/**
 * Gets available options for the Preview form controls.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 *
 * @return array
 *   A keyed arary of options for the JS Preview.
 */
function _custom_formatters_preview_variables($form, $form_state) {
  $options = array();
  $item = !empty($form_state['values']) ? $form_state['values'] : (array) $form_state['item'];
  if (!is_array($item['field_types'])) {
    $item['field_types'] = drupal_explode_tags($item['field_types']);
  }

  // Entity Types.
  $options['entity_types'] = array();
  $entity_types = entity_get_info();
  foreach ($entity_types as $key => $entity) {
    if ($entity['fieldable']) {
      $options['entity_types'][$key] = $entity['label'];
    }
  }

  // Bundles.
  $options['bundles'] = array();
  if (!empty($options['entity_types'])) {
    $entity_type = !empty($item['preview']['entity_type']) ? $item['preview']['entity_type'] : 'node';
    foreach ($entity_types[$entity_type]['bundles'] as $key => $bundle) {
      $options['bundles'][$key] = $bundle['label'];
    }
  }

  // Fields.
  $options['fields'] = array();
  if (isset($entity_type) && !empty($options['bundles'])) {
    $bundle = !empty($item['preview']['bundle']) && isset($options['bundles'][$item['preview']['bundle']]) ? $item['preview']['bundle'] : key($options['bundles']);
    $fields = field_info_instances($entity_type, $bundle);
    foreach ($fields as $key => $field) {
      $field_info = field_info_field_by_id($field['field_id']);
      if (in_array($field_info['type'], $item['field_types'])) {
        $options['fields'][$key] = $field['label'];
      }
    }
  }

  // Entities.
  $options['entities'] = array();
  if (isset($entity_type) && isset($bundle) && !empty($options['fields'])) {
    $field = !empty($item['preview']['field']) ? $item['preview']['field'] : key($options['fields']);
    if (strstr($field, 'field_')) {
      $query = new EntityFieldQuery();
      $query
        ->entityCondition('entity_type', $entity_type)
        ->entityCondition('bundle', $bundle)
        ->addTag('random')
        ->range(0, 50)
        ->fieldCondition($field);
      $result = $query
        ->execute();
      if (!empty($result)) {
        $entities = entity_load($entity_type, array_keys($result[$entity_type]));
        foreach ($entities as $key => $entity) {
          $options['entities'][$key] = entity_label($entity_type, $entity) . " [eid:{$key}]";
        }
      }
    }
  }
  return $options;
}

/**
 * Implements hook_query_TAG_alter().
 */
function custom_formatters_query_random_alter(QueryAlterableInterface $query) {
  $query
    ->orderRandom();
}

/**
 * AJAX callback for Custom formatters form.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 *
 * @return array
 *   A fapi array.
 */
function custom_formatters_export_ui_form_js($form, $form_state) {

  // Clear messages.
  drupal_get_messages(NULL, TRUE);
  $engines = module_invoke_all('custom_formatters_engine_info');
  $engine = $form_state['values']['mode'];
  if (isset($engines[$engine]['file']) && file_exists($engines[$engine]['file'])) {
    require_once $engines[$engine]['file'];
  }
  return $form['engine'];
}

/**
 * AJAX callback form Custom formatters preview form.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 * @param null|object $object
 *   The Custom formatter object if supplied, else NULL.
 *
 * @return array
 *   A fapi array.
 */
function custom_formatters_export_ui_form_js_preview($form, $form_state, $object = NULL) {

  // Clear messages.
  drupal_get_messages(NULL, TRUE);

  // Build preview elements.
  $elements['obj_type'] = $form_state['values']['preview']['entity_type'];
  $elements['object'] = $object;
  if (is_null($elements['object'])) {
    $objects = entity_load($elements['obj_type'], array(
      $form_state['values']['preview']['entity'],
    ));
    $elements['object'] = $objects[$form_state['values']['preview']['entity']];
  }
  if (strstr($form_state['values']['preview']['field'], 'field_')) {
    $elements['field'] = field_info_field($form_state['values']['preview']['field']);
    $elements['instance'] = field_info_instance($elements['obj_type'], $elements['field']['field_name'], $form_state['values']['preview']['bundle']);
    $elements['langcode'] = field_language($elements['obj_type'], $elements['object'], $elements['field']['field_name']);
    $elements['items'] = field_get_items($elements['obj_type'], $elements['object'], $elements['instance']['field_name'], $elements['langcode']);

    // Prepare field view.
    $functions = array(
      "{$elements['field']['module']}_field_prepare_view",
      "{$elements['field']['module']}_field_load",
    );
    foreach ($functions as $function) {
      if (function_exists($function)) {
        $elements['items'] = array(
          $elements['items'],
        );
        $function($elements['obj_type'], array(
          $elements['object'],
        ), $elements['field'], array(
          $elements['instance'],
        ), $elements['langcode'], $elements['items'], FIELD_LOAD_CURRENT);
        $elements['items'] = $elements['items'][0];
      }
    }
    $elements['display'] = $elements['instance']['display']['default'];
  }
  drupal_alter('custom_formatters_preview_elements', $elements, $form_state['values']);
  extract($elements);

  // @TODO - Allow this to be done via form_builder.inc or any other Foramtter
  // Settings integration modules.
  $display['settings'] = isset($form_state['input']['settings']['preview']) ? $form_state['input']['settings']['preview'] : $display['settings'];

  // Disable contextual links in preview.
  $display['#cf_options'] = array(
    '#contextual_links' => FALSE,
  );
  $formatter = (object) $form_state['values'];

  // Build the preview html.
  $element = custom_formatters_field_formatter_view($obj_type, $object, $field, $instance, $langcode, $items, $display, $formatter);
  $variables = array(
    'element' => array_merge($element, array(
      '#label_display' => 'hidden',
      '#title' => NULL,
      '#items' => $element,
      '#field_name' => $field['field_name'],
      '#field_type' => $field['type'],
    )),
  );
  foreach (array_keys($element) as $delta) {
    $variables['item_attributes'][$delta] = NULL;
  }
  $js = drupal_add_js();
  $form['engine']['preview']['preview']['content'] = array(
    '#markup' => theme('field', $variables),
  );
  $js = array_diff_assoc(drupal_add_js(), $js);
  $form['engine']['preview']['preview']['content']['#markup'] .= drupal_get_js('header', $js);

  // Preview debugging; Show the output HTML.
  if (module_exists('devel') && isset($formatter->preview) && $formatter->preview['options']['dpm']['html']) {
    dpm(theme('field', $variables));
  }
  return $form['engine']['preview']['preview'];
}

/**
 * Submit callback for Custom Formatters settings form.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 */
function custom_formatters_export_ui_form_submit(&$form, &$form_state) {
  field_cache_clear();
  $engines = module_invoke_all('custom_formatters_engine_info');
  if (isset($engines[$form_state['values']['mode']])) {
    $engine = $engines[$form_state['values']['mode']];
    if (isset($engine['file']) && file_exists($engine['file'])) {
      require_once $engine['file'];
    }
    if (isset($engine['callbacks']['settings form submit']) && function_exists($engine['callbacks']['settings form submit'])) {
      $engine['callbacks']['settings form submit']($form, $form_state);
    }
  }
  if ($form_state['values']['op'] == t('Save & Edit')) {
    $destination = "admin/structure/formatters/list/{$form_state['values']['name']}/edit";
    $_GET['destination'] = isset($_GET['destination']) ? $destination . "?destination={$_GET['destination']}" : $destination;
  }
}

/**
 * Provide a form for displaying an export.
 *
 * @param array $form
 *   The form api array.
 * @param array $form_state
 *   The form state array.
 * @param object $item
 *   The Custom formatter object.
 * @param string $title
 *   The textarea field title.
 *
 * @return mixed
 *   A form api array.
 */
function custom_formatters_export_ui_export_form($form, &$form_state, $item, $title = '') {
  $form['mode'] = array(
    '#type' => 'select',
    '#title' => t('Mode'),
    '#options' => array(
      'default' => t('CTools exportable (default)'),
      'drupal' => t('Drupal API'),
    ),
    '#default_value' => 'default',
    '#ajax' => array(
      'callback' => 'custom_formatters_export_ui_export_form_js',
      'wrapper' => 'export-wrapper',
    ),
  );
  $form['export'] = array(
    '#type' => 'container',
    '#prefix' => '<div id="export-wrapper">',
    '#suffix' => '</div>',
  );
  $mode = isset($form_state['values']['mode']) ? $form_state['values']['mode'] : $form['mode']['#default_value'];
  switch ($mode) {
    case 'default':
      $code = ctools_export_crud_export('formatters', $item);
      break;
    case 'drupal':
      $engines = module_invoke_all('custom_formatters_engine_info');
      $engine = $item->mode;
      if (isset($engines[$engine]['file']) && file_exists($engines[$engine]['file'])) {
        require_once $engines[$engine]['file'];
      }
      $module = isset($form_state['values']['module']) ? $form_state['values']['module'] : t('MYMODULE');
      $form['export']['module'] = array(
        '#type' => 'textfield',
        '#title' => t('Module name'),
        '#default_value' => $module,
        '#ajax' => array(
          'callback' => 'custom_formatters_export_ui_export_form_js',
          'wrapper' => 'export-wrapper',
        ),
      );
      $code = $engines[$engine]['callbacks']['export']($item, $module);
      break;
  }
  $lines = substr_count($code, "\n");
  $form['export']['code'] = array(
    '#type' => 'textarea',
    '#title' => check_plain($title),
    '#value' => $code,
    '#rows' => $lines,
  );
  return $form;
}

/**
 * AJAX callback for Custom Formatters export form.
 *
 * @param array $form
 *   The form api array.
 *
 * @return mixed
 *   The export form object.
 */
function custom_formatters_export_ui_export_form_js($form) {
  return $form['export'];
}

/**
 * Theme for Preview form.
 *
 * @param array $variable
 *   The theme variables array.
 *
 * @return string
 *   The rendered output.
 */
function theme_custom_formatters_export_ui_form_preview($variable) {
  $form = $variable['form'];
  $output = '';
  $output .= theme('table', array(
    'rows' => array(
      array(
        render($form['entity_type']),
        render($form['bundle']),
        render($form['field']),
        render($form['entity']),
      ),
      array(
        array(
          'data' => render($form['options']),
          'colspan' => 3,
        ),
        render($form['button']),
      ),
    ),
  ));
  $output .= render($form['preview']);
  return $output;
}

Functions

Name	Description
custom_formatters_custom_formatters_ctools_export_ui	CTools Export UI required function for plugin definition.
custom_formatters_export_ui_export_form	Provide a form for displaying an export.
custom_formatters_export_ui_export_form_js	AJAX callback for Custom Formatters export form.
custom_formatters_export_ui_form	Custom Formatters settings form.
custom_formatters_export_ui_form_js	AJAX callback for Custom formatters form.
custom_formatters_export_ui_form_js_preview	AJAX callback form Custom formatters preview form.
custom_formatters_export_ui_form_submit	Submit callback for Custom Formatters settings form.
custom_formatters_query_random_alter	Implements hook_query_TAG_alter().
theme_custom_formatters_export_ui_form_preview	Theme for Preview form.
_custom_formatters_preview_variables	Gets available options for the Preview form controls.