views_rss_core.field.inc in Views RSS 7.2

Field formatters for Views RSS: Core Elements module.

File

modules/views_rss_core/views_rss_core.field.inc

<?php

/**
 * @file
 * Field formatters for Views RSS: Core Elements module.
 */

/**
 * Implements hook_field_formatter_info().
 */
function views_rss_core_field_formatter_info() {
  $formatters = array(
    'enclosure' => array(
      'label' => t('RSS <enclosure> element'),
      'field types' => array(
        'file',
        'media',
        'image',
        'text',
        'link_field',
      ),
    ),
  );
  return $formatters;
}

/**
 * Implements hook_field_formatter_settings_form().
 */
function views_rss_core_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $element = NULL;
  if ($field['type'] == 'image') {
    $image_styles = image_style_options(FALSE);
    $element['image_style'] = array(
      '#title' => t('Image style'),
      '#type' => 'select',
      '#default_value' => $settings['image_style'],
      '#empty_option' => t('None (original image)'),
      '#options' => $image_styles,
    );
  }
  return $element;
}

/**
 * Implements hook_field_formatter_settings_summary().
 */
function views_rss_core_field_formatter_settings_summary($field, $instance, $view_mode) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $summary = array();
  if ($field['type'] == 'image') {
    $image_styles = image_style_options(FALSE);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    if (!empty($settings['image_style']) && !empty($image_styles[$settings['image_style']])) {
      $summary[] = t('Image style: @style', array(
        '@style' => $image_styles[$settings['image_style']],
      ));
    }
    else {
      $summary[] = t('Original image');
    }
  }
  return implode('<br />', $summary);
}

/**
 * Implements hook_field_formatter_view().
 *
 * This is a dirty trick here. Essentially, we do not want to call a theme
 * function from here, as it should be called from within a view (amongst
 * other to have $view object in $variables). Therefore here we want to
 * return value only, hence use of array('#markup' => $value). However,
 * in some cases it won't be just a simple string value to return,
 * sometimes we'd want to return an array (for example value with
 * additional arguments) - hence the need to serialize it (plus add
 * "serialized" string at the beginning so that our field preprocess
 * function template_preprocess_views_view_views_rss_field() is able
 * to recognize it as serialized array and treat accordingly.
 *
 * Any better ideas?
 */
function views_rss_core_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  $element = NULL;
  foreach ($items as $delta => $item) {

    // Inside a view item may contain NULL data. In that case, just return.
    if (($field['type'] == 'file' || $field['type'] == 'image') && empty($item['fid']) || $field['type'] == 'media' && empty($item['file']->fid) || $field['type'] == 'text' && empty($item['safe_value']) || $field['type'] == 'link_field' && empty($item['url'])) {
      unset($items[$delta]);
      continue;
    }

    // Get full image URL based on provided image style.
    if ($field['type'] == 'image' && !empty($display['settings']['image_style']) && ($image_style = image_style_load($display['settings']['image_style']))) {
      $uri = image_style_url($display['settings']['image_style'], $item['uri']);

      // Get file size of image preset file (if it has already been created,
      // otherwise just create it first and then get file size).
      $path = image_style_path($display['settings']['image_style'], $item['uri']);
      if (file_exists($path) || image_style_create_derivative($image_style, $item['uri'], $path)) {
        $item['filesize'] = filesize($path);
      }
    }
    elseif ($field['type'] == 'media') {
      $uri = file_create_url($item['file']->uri);
      $item['filesize'] = $item['file']->filesize;
      $item['filemime'] = $item['file']->filemime;
    }
    elseif ($field['type'] == 'text' || $field['type'] == 'link_field') {
      $uri = $field['type'] == 'text' ? $item['safe_value'] : $item['url'];

      // Great idea to use get_headers() here by Dan Feidt,
      // http://drupal.org/user/60005 Thanks Dan!
      $headers = get_headers($uri, $format = 1);
      $item['filesize'] = $headers['Content-Length'];
      $item['filemime'] = $headers['Content-Type'];
    }
    else {
      $uri = file_create_url($item['uri']);
    }

    // XML element array in format_xml_elements() format.
    $rss_element = array(
      'key' => 'enclosure',
      'attributes' => array(
        'url' => $uri,
        'length' => $item['filesize'],
        'type' => $item['filemime'],
      ),
    );
    $element[$delta] = array(
      '#item' => $item,
      '#markup' => format_xml_elements(array(
        $rss_element,
      )),
      '#rss_element' => $rss_element,
    );
  }
  return $element;
}

Functions

Name	Description
views_rss_core_field_formatter_info	Implements hook_field_formatter_info().
views_rss_core_field_formatter_settings_form	Implements hook_field_formatter_settings_form().
views_rss_core_field_formatter_settings_summary	Implements hook_field_formatter_settings_summary().
views_rss_core_field_formatter_view	Implements hook_field_formatter_view().