You are here

class RssFields in Views (for Drupal 7) 8.3

Renders an RSS item based on fields.

Plugin annotation


@Plugin(
  id = "rss_fields",
  title = @Translation("Fields"),
  help = @Translation("Display fields as RSS items."),
  theme = "views_view_row_rss",
  type = "feed"
)

Hierarchy

Expanded class hierarchy of RssFields

File

lib/Drupal/views/Plugin/views/row/RssFields.php, line 24
Definition of Drupal\views\Plugin\views\row\RssFields.

Namespace

Drupal\views\Plugin\views\row
View source
class RssFields extends RowPluginBase {

  /**
   * Does the row plugin support to add fields to it's output.
   *
   * @var bool
   */
  protected $usesFields = TRUE;
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['title_field'] = array(
      'default' => '',
    );
    $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;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $initial_labels = array(
      '' => t('- None -'),
    );
    $view_fields_labels = $this->displayHandler
      ->getFieldLabels();
    $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'],
    );
  }
  public 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
      ->themeFunctions(), 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);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
RowPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
RowPluginBase::init public function Initialize the row plugin. 1
RowPluginBase::pre_render function Allow the style to do stuff before each row is rendered. 3
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields function Returns the usesFields property. 2
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
RssFields::$usesFields protected property Does the row plugin support to add fields to it's output. Overrides RowPluginBase::$usesFields
RssFields::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
RssFields::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides RowPluginBase::defineOptions
RssFields::get_field function Retrieves a views field value from the style plugin.
RssFields::render function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
RssFields::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate