From 72d50caafc3bdbb8b3cfd46a33ba6899cf8f544b Mon Sep 17 00:00:00 2001 From: marvil07 Date: Wed, 21 Mar 2012 16:18:34 -0600 Subject: [PATCH] Issue #1465306 by marvil07: Add a fields row style for RSS items. --- includes/plugins.inc | 10 ++ plugins/views_plugin_row_rss_fields.inc | 180 +++++++++++++++++++++++++++++++ views.info | 1 + 3 files changed, 191 insertions(+), 0 deletions(-) create mode 100644 plugins/views_plugin_row_rss_fields.inc diff --git a/includes/plugins.inc b/includes/plugins.inc index ddf870d..a948d58 100644 --- a/includes/plugins.inc +++ b/includes/plugins.inc @@ -194,6 +194,16 @@ function views_views_plugins() { 'type' => 'normal', 'help topic' => 'style-row-fields', ), + 'rss_fields' => array( + 'title' => t('Fields'), + 'help' => t('Display fields as RSS items.'), + 'handler' => 'views_plugin_row_rss_fields', + 'theme' => 'views_view_row_rss', + 'uses fields' => TRUE, + 'uses options' => TRUE, + 'type' => 'feed', + 'help topic' => 'style-row-fields', + ), ), 'argument default' => array( 'parent' => array( diff --git a/plugins/views_plugin_row_rss_fields.inc b/plugins/views_plugin_row_rss_fields.inc new file mode 100644 index 0000000..9355e83 --- /dev/null +++ b/plugins/views_plugin_row_rss_fields.inc @@ -0,0 +1,180 @@ + ''); + $options['link_field'] = array('default' => ''); + $options['description_field'] = array('default' => ''); + $options['creator_field'] = array('default' => ''); + $options['date_field'] = array('default' => ''); + $options['guid_field_options']['guid_field'] = array('default' => ''); + $options['guid_field_options']['guid_field_is_permalink'] = array('default' => TRUE, 'bool' => TRUE); + return $options; + } + + function options_form(&$form, &$form_state) { + parent::options_form($form, $form_state); + + $initial_labels = array('' => t('- None -')); + $view_fields_labels = $this->display->handler->get_field_labels(); + $view_fields_labels = array_merge($initial_labels, $view_fields_labels); + + $form['title_field'] = array( + '#type' => 'select', + '#title' => t('Title field'), + '#description' => t('The field that is going to be used as the RSS item title for each row.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['title_field'], + '#required' => TRUE, + ); + $form['link_field'] = array( + '#type' => 'select', + '#title' => t('Link field'), + '#description' => t('The field that is going to be used as the RSS item link for each row. This must be a drupal relative path.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['link_field'], + '#required' => TRUE, + ); + $form['description_field'] = array( + '#type' => 'select', + '#title' => t('Description field'), + '#description' => t('The field that is going to be used as the RSS item description for each row.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['description_field'], + '#required' => TRUE, + ); + $form['creator_field'] = array( + '#type' => 'select', + '#title' => t('Creator field'), + '#description' => t('The field that is going to be used as the RSS item creator for each row.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['creator_field'], + '#required' => TRUE, + ); + $form['date_field'] = array( + '#type' => 'select', + '#title' => t('Publication date field'), + '#description' => t('The field that is going to be used as the RSS item pubDate for each row. It needs to be in RFC 2822 format.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['date_field'], + '#required' => TRUE, + ); + $form['guid_field_options'] = array( + '#type' => 'fieldset', + '#title' => t('GUID settings'), + '#collapsible' => FALSE, + '#collapsed' => FALSE, + ); + $form['guid_field_options']['guid_field'] = array( + '#type' => 'select', + '#title' => t('GUID field'), + '#description' => t('The globally unique identifier of the RSS item.'), + '#options' => $view_fields_labels, + '#default_value' => $this->options['guid_field_options']['guid_field'], + '#required' => TRUE, + ); + $form['guid_field_options']['guid_field_is_permalink'] = array( + '#type' => 'checkbox', + '#title' => t('GUID is permalink'), + '#description' => t('The RSS item GUID is a permalink.'), + '#default_value' => $this->options['guid_field_options']['guid_field_is_permalink'], + ); + } + + function validate() { + $errors = parent::validate(); + $required_options = array('title_field', 'link_field', 'description_field', 'creator_field', 'date_field'); + foreach ($required_options as $required_option) { + if (empty($this->options[$required_option])) { + $errors[] = t('Row style plugin requires specifying which views fields to use for RSS item.'); + break; + } + } + // Once more for guid. + if (empty($this->options['guid_field_options']['guid_field'])) { + $errors[] = t('Row style plugin requires specifying which views fields to use for RSS item.'); + } + return $errors; + } + + function render($row) { + static $row_index; + if (!isset($row_index)) { + $row_index = 0; + } + if (function_exists('rdf_get_namespaces')) { + // Merge RDF namespaces in the XML namespaces in case they are used + // further in the RSS content. + $xml_rdf_namespaces = array(); + foreach (rdf_get_namespaces() as $prefix => $uri) { + $xml_rdf_namespaces['xmlns:' . $prefix] = $uri; + } + $this->view->style_plugin->namespaces += $xml_rdf_namespaces; + } + + // Create the RSS item object. + $item = new stdClass(); + $item->title = $this->get_field($row_index, $this->options['title_field']); + $item->link = url($this->get_field($row_index, $this->options['link_field']), array('absolute' => TRUE)); + $item->description = $this->get_field($row_index, $this->options['description_field']); + $item->elements = array( + array('key' => 'pubDate', 'value' => $this->get_field($row_index, $this->options['date_field'])), + array( + 'key' => 'dc:creator', + 'value' => $this->get_field($row_index, $this->options['creator_field']), + 'namespace' => array('xmlns:dc' => 'http://purl.org/dc/elements/1.1/'), + ), + ); + $guid_is_permalink_string = 'false'; + $item_guid = $this->get_field($row_index, $this->options['guid_field_options']['guid_field']); + if ($this->options['guid_field_options']['guid_field_is_permalink']) { + $guid_is_permalink_string = 'true'; + $item_guid = url($item_guid, array('absolute' => TRUE)); + } + $item->elements[] = array( + 'key' => 'guid', + 'value' => $item_guid, + 'attributes' => array('isPermaLink' => $guid_is_permalink_string), + ); + + $row_index++; + + foreach ($item->elements as $element) { + if (isset($element['namespace'])) { + $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $element['namespace']); + } + } + + return theme($this->theme_functions(), + array( + 'view' => $this->view, + 'options' => $this->options, + 'row' => $item, + 'field_alias' => isset($this->field_alias) ? $this->field_alias : '', + )); + } + + /** + * Retrieves a views field value from the style plugin. + * + * @param $index + * The index count of the row as expected by views_plugin_style::get_field(). + * @param $field_id + * The ID assigned to the required field in the display. + */ + function get_field($index, $field_id) { + if (empty($this->view->style_plugin) || !is_object($this->view->style_plugin) || empty($field_id)) { + return ''; + } + return $this->view->style_plugin->get_field($index, $field_id); + } + +} diff --git a/views.info b/views.info index d8011a1..db1a79a 100644 --- a/views.info +++ b/views.info @@ -236,6 +236,7 @@ files[] = plugins/views_plugin_query.inc files[] = plugins/views_plugin_query_default.inc files[] = plugins/views_plugin_row.inc files[] = plugins/views_plugin_row_fields.inc +files[] = plugins/views_plugin_row_rss_fields.inc files[] = plugins/views_plugin_style.inc files[] = plugins/views_plugin_style_default.inc files[] = plugins/views_plugin_style_grid.inc -- 1.7.4.4