entity2text.module in Entity To Text 7

File

entity2text.module

<?php

/**
 * Implements hook_token_info_alter().
 *
 * Provide a token for each View Mode for each Entity Type.
 */
function entity2text_token_info_alter(&$data) {
  $entity_infos = entity_get_info();
  foreach ($entity_infos as $enity_type => $entity_info) {
    if (isset($data['tokens'][$enity_type])) {
      foreach ($entity_info['view modes'] as $view_name => $view_mode) {
        $data['tokens'][$enity_type]['textexport-' . $view_name] = array(
          'name' => 'Text Export: ' . $view_mode['label'],
          'description' => "Exports the enity text using View Mode " . $view_mode['label'],
          'type' => 'text',
        );
      }
    }
  }
}

/**
 * Implements hook_module_implements_alter().
 *
 * Make sure this runs after entity_token_token_info_alter so that entity info is already given.
 * @see entity_token_token_info_alter()
 */
function entity2text_module_implements_alter(&$implementations, $hook) {
  if ($hook === "token_info_alter") {
    $temp = $implementations['entity2text'];

    // Removing the mymodule key/value
    unset($implementations['entity2text']);

    // Adding the mymodule key value as the last member in the list
    $implementations['entity2text'] = $temp;
  }
}

/**
 * Implements hook_tokens().
 *
 * Replace tokens created by this module with Entity rendered as text for the View Mode
 */
function entity2text_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $replacements = array();
  $entity_types = array_keys(entity_get_info());
  if (in_array($type, $entity_types)) {
    foreach ($tokens as $token_key => $value) {
      $token_parts = explode('-', $token_key);
      if ($token_parts[0] == 'textexport') {

        //created by this module
        $view_mode = $token_parts[1];
        $entity_type = $type;
        $entity = $data[$type];
        $rendered_text = entity2text_render_entity_to_text($entity_type, $entity, $view_mode);
        $replacements[$value] = $rendered_text;
      }
    }
  }
  return $replacements;
}

/*
 * Return rendered text for Entity
 */
function entity2text_render_entity_to_text($entity_type, $entity, $view_mode) {
  $rendered_entity = entity_view($entity_type, array(
    $entity,
  ), $view_mode);
  $text = entity2text_renderarray_to_text($rendered_entity);
  return $text;
}

/*
 * Return the text output for a Drupal Renderable Array
 * @todo Improve Conversion to text.
 * @todo Handle files - links
 * @todo Allow selection of different functions to use for rendering to text.
 */
function entity2text_renderarray_to_text($render_array, $print_empty_title = FALSE, $indent_text = '') {
  $tab_text = "   ";
  $output = '';
  $markup = '';
  $title = '';
  if (!empty($render_array['#markup'])) {
    $markup .= "{$indent_text}{$tab_text}" . htmlspecialchars_decode(strip_tags($render_array['#markup']));
    $markup = trim($markup);
  }
  if (isset($render_array['#title'])) {
    $title .= htmlspecialchars_decode(strip_tags($render_array['#title'])) . ":";
    $title = trim($title);
  }
  if (!empty($markup) && empty($title)) {
    $output .= "\n" . $indent_text . $markup . "\n";
  }
  elseif (!empty($markup) && !empty($title)) {
    $output .= "\n" . $indent_text . $title . "\n" . $indent_text . $tab_text . $markup;
  }
  elseif (empty($markup) && !empty($title)) {
    $output .= "\n" . $indent_text . $title;
  }
  if (!empty($output)) {
    $indent_text .= $tab_text;
  }
  foreach (element_children($render_array) as $child) {

    // Make any final changes to the element before it is maybe rendered. This
    // means that the $element or the children can be altered or corrected
    // before the element is rendered into the final text.
    if (isset($render_array[$child]['#pre_render'])) {
      foreach ($render_array[$child]['#pre_render'] as $function) {
        if (function_exists($function)) {
          $render_array[$child] = $function($render_array[$child]);
        }
      }
    }

    // If there's a type use it to render the element. E.g. address field only
    // adds the proper output values in this step.
    if (isset($render_array[$child]['#type'])) {
      $rendered = drupal_render($render_array[$child]);

      // Add line breaks to all block end tags, then strip all tags and
      // sanitize.
      $child_text = "\n{$indent_text}{$tab_text}" . htmlspecialchars_decode(strip_tags(entity2text_block_hmlt_entities_to_nl($rendered, $indent_text . $tab_text)));
    }
    else {
      $child_text = entity2text_renderarray_to_text($render_array[$child], $print_empty_title, $indent_text);
    }
    if (isset($render_array[$child]['#weight'])) {
      $child_array[$render_array[$child]['#weight']] = $child_text;
    }
    else {
      $child_array[] = $child_text;
    }
  }
  if (!empty($child_array)) {
    ksort($child_array);
    $output .= implode('', $child_array);
  }
  return $output;
}

/**
 * Converts block / line wrapping html elements to breaks.
 *
 * @param string $text
 *   The text to process.
 * @param string $indent_text
 *   The indent text.
 *
 * @return string
 *   The processed text.
 */
function entity2text_block_hmlt_entities_to_nl($text, $indent_text = '') {

  // Replace tags where nesting should only cause one break.
  $text = preg_replace('/(\\<(\\/\\s*(div|dd|dl|article|figure|aside|footer|ol|output|audio|form|blockquote|canvas|section|hgroup|tfoot|main|nav|video|figcaption))(\\s*)?\\/?\\>)+/i', "\n" . $indent_text, $text);

  // Replace tags where a tag always creates a break.
  $text = preg_replace('/\\<(br|hr|\\/\\s*(fieldset|ul|table|pre|h1|h2|h3|h4|h5|h6))(\\s*)?\\/?\\>/i', "\n" . $indent_text, $text);
  return $text;
}

Functions

Name	Description
entity2text_block_hmlt_entities_to_nl	Converts block / line wrapping html elements to breaks.
entity2text_module_implements_alter	Implements hook_module_implements_alter().
entity2text_renderarray_to_text
entity2text_render_entity_to_text
entity2text_tokens	Implements hook_tokens().
entity2text_token_info_alter	Implements hook_token_info_alter().