views_rss_core.inc in Views RSS 6.2

Preprocess functions for Views RSS: Core Elements module.

File

modules/views_rss_core/views_rss_core.inc

<?php

/**
 * @file
 * Preprocess functions for Views RSS: Core Elements module.
 */

/**
 * Preprocess function for channel <title> element.
 */
function views_rss_core_preprocess_channel_title(&$variables) {
  $view_title = $variables['view']
    ->get_title();
  $variables['value'] = $view_title ? $view_title : variable_get('site_name', t('Drupal'));
}

/**
 * Preprocess function for channel <description> element.
 */
function views_rss_core_preprocess_channel_description(&$variables) {
  $variables['value'] = $variables['value'] ? $variables['value'] : variable_get('site_slogan', '');
}

/**
 * Preprocess function for channel <link> element.
 */
function views_rss_core_preprocess_channel_link(&$variables) {
  $variables['value'] = url('<front>', array(
    'absolute' => TRUE,
  ));
}

/**
 * Preprocess function for channel <atom:link> element.
 */
function views_rss_core_preprocess_channel_atom_link(&$variables) {
  $url_options = array(
    'absolute' => TRUE,
  );
  $input = $variables['view']
    ->get_exposed_input();
  if ($input) {
    $url_options['query'] = $input;
  }
  $url = url($variables['view']
    ->get_url(), $url_options);
  $variables['value'] = array(
    'arguments' => array(
      'rel' => 'self',
      'href' => $url,
    ),
  );
}

/**
 * Preprocess function for channel <category> element.
 */
function views_rss_core_preprocess_channel_category(&$variables) {

  // No value = no preprocessing.
  if (empty($variables['value'])) {
    return;
  }
  $elements = array();
  $categories = explode(',', $variables['value']);
  foreach ($categories as $category) {
    $elements[] = array(
      'element' => $variables['element'],
      'value' => trim($category),
    );
  }
  $variables['value'] = array(
    'elements' => $elements,
  );
}

/**
 * Preprocess function for channel <image> element.
 */
function views_rss_core_preprocess_channel_image(&$variables) {

  // No value = no preprocessing.
  if (empty($variables['value'])) {
    return;
  }
  $path = $variables['value'];

  // Get value of channel <title> element from its preprocess function.
  views_rss_core_preprocess_channel_title($variables);
  $title = $variables['value'];

  // Get value of channel <title> element from its preprocess function.
  views_rss_core_preprocess_channel_link($variables);
  $link = $variables['value'];

  // Create subelements array.
  $subelements = array(
    'url' => array(
      'element' => 'url',
      'value' => url($path, array(
        'absolute' => TRUE,
      )),
    ),
    'title' => array(
      'element' => 'title',
      'value' => $title,
    ),
    'link' => array(
      'element' => 'link',
      'value' => $link,
    ),
  );

  // Try to get image description from website's mission.
  $site_slogan = variable_get('site_slogan', '');
  if (!empty($site_slogan)) {
    $subelements['description'] = array(
      'element' => 'description',
      'value' => $site_slogan,
    );
  }

  // Get image width and height.
  $real_path = realpath($path);
  if (file_exists($real_path)) {
    list($width, $height) = getimagesize($real_path);
    $subelements['width'] = array(
      'element' => 'width',
      'value' => $width,
    );
    $subelements['height'] = array(
      'element' => 'height',
      'value' => $height,
    );
  }

  // Assign generated subelements array back to $variables.
  $variables['value'] = array(
    'subelements' => $subelements,
  );
}

/**
 * Preprocess function for channel <pubDate> and <lastBuildDate> elements.
 *
 * It will return values for date element providing that original Views query
 * was modified appropriately by views_rss_core_views_query_alter() by adding
 * new fields to SELECT clause retrieving object creation (for <pubDate>)
 * or modification timestamp (for <lastBuildDate>).
 */
function views_rss_core_preprocess_channel_date(&$variables) {
  if (count($variables['view']->result) > 0) {
    $max_date = 0;
    foreach ($variables['view']->result as $row) {
      if (isset($row->{$variables['element']}) && $row->{$variables['element']} > $max_date) {
        $max_date = $row->{$variables['element']};
      }
    }
    if ($max_date) {
      $variables['value'] = date('r', $max_date);
    }
  }
}

/**
 * Preprocess function for channel <skipHours> and <skipDays> elements.
 */
function views_rss_core_preprocess_channel_skip(&$variables) {

  // No value = no preprocessing.
  if (empty($variables['value'])) {
    return;
  }
  $element = array(
    'element' => $variables['element'],
    'subelements' => array(),
  );
  foreach (explode(',', strip_tags($variables['value'])) as $skip_value) {
    $element['subelements'][] = array(
      'element' => $variables['element'] == 'skipHours' ? 'hour' : 'day',
      'value' => trim($skip_value),
    );
  }
  $variables['value'] = $element;
}

/**
 * Preprocess function for channel <cloud> element.
 */
function views_rss_core_preprocess_channel_cloud(&$variables) {

  // No value = no preprocessing.
  if (empty($variables['value'])) {
    return;
  }
  if ($url = parse_url($variables['value'])) {
    $variables['value'] = array(
      'arguments' => array(
        'domain' => $url['host'],
        'port' => $url['port'],
        'path' => $url['path'],
        'registerProcedure' => $url['fragment'],
        'protocol' => $url['scheme'],
      ),
    );
  }
}

/**
 * Preprocess function for item <guid> element.
 */
function views_rss_core_preprocess_item_guid(&$variables) {

  // No value = no preprocessing.
  if (empty($variables['value'])) {
    return;
  }
  $value = array(
    'value' => $variables['value'],
    'arguments' => array(
      'isPermaLink' => 'false',
    ),
  );
  if ((!isset($variables['item']['views_rss_core']['link']) || empty($variables['item']['views_rss_core']['link'])) && valid_url($value['value'], TRUE)) {
    $value['arguments']['isPermaLink'] = 'true';
  }
  $variables['value'] = $value;
}

/**
 * Preprocess function for item <source> element.
 */
function views_rss_core_preprocess_item_source(&$variables) {
  $url_options = array(
    'absolute' => TRUE,
  );
  $input = $variables['view']
    ->get_exposed_input();
  if ($input) {
    $url_options['query'] = $input;
  }
  $url = url($variables['view']
    ->get_url(), $url_options);
  $view_title = $variables['view']
    ->get_title();
  $variables['value'] = array(
    'value' => check_plain($view_title ? $view_title : variable_get('site_name', t('Drupal'))),
    'arguments' => array(
      'url' => $url,
    ),
  );
}

Functions

Name	Description
views_rss_core_preprocess_channel_atom_link	Preprocess function for channel <atom:link> element.
views_rss_core_preprocess_channel_category	Preprocess function for channel <category> element.
views_rss_core_preprocess_channel_cloud	Preprocess function for channel <cloud> element.
views_rss_core_preprocess_channel_date	Preprocess function for channel <pubDate> and <lastBuildDate> elements.
views_rss_core_preprocess_channel_description	Preprocess function for channel <description> element.
views_rss_core_preprocess_channel_image	Preprocess function for channel <image> element.
views_rss_core_preprocess_channel_link	Preprocess function for channel <link> element.
views_rss_core_preprocess_channel_skip	Preprocess function for channel <skipHours> and <skipDays> elements.
views_rss_core_preprocess_channel_title	Preprocess function for channel <title> element.
views_rss_core_preprocess_item_guid	Preprocess function for item <guid> element.
views_rss_core_preprocess_item_source	Preprocess function for item <source> element.