You are here

class Rss in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Views/node/Plugin/views/row/Rss.php \Views\node\Plugin\views\row\Rss
  2. 8.3 lib/Views/comment/Plugin/views/row/Rss.php \Views\comment\Plugin\views\row\Rss
  3. 8.3 lib/Views/aggregator/Plugin/views/row/Rss.php \Views\aggregator\Plugin\views\row\Rss
  4. 8.3 lib/Drupal/views/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss

Plugin which loads an aggregator item and formats it as an RSS item.

Plugin annotation


@Plugin(
  id = "aggregator_rss",
  module = "aggregator",
  theme = "views_view_row_rss",
  title = @Translation("Aggregator item"),
  help = @Translation("Display the aggregator item using the data from the original source."),
  type = "feed"
)

Hierarchy

Expanded class hierarchy of Rss

File

lib/Views/aggregator/Plugin/views/row/Rss.php, line 26
Definition of Views\aggregator\Plugin\views\row\Rss.

Namespace

Views\aggregator\Plugin\views\row
View source
class Rss extends RowPluginBase {
  var $base_table = 'aggregator_item';
  var $base_field = 'iid';
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['item_length'] = array(
      'default' => 'default',
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    $form['item_length'] = array(
      '#type' => 'select',
      '#title' => t('Display type'),
      '#options' => array(
        'fulltext' => t('Full text'),
        'teaser' => t('Title plus teaser'),
        'title' => t('Title only'),
        'default' => t('Use default RSS settings'),
      ),
      '#default_value' => $this->options['item_length'],
    );
  }
  function render($row) {
    $iid = $row->{$this->field_alias};
    $query = db_select('aggregator_item', 'ai');
    $query
      ->leftJoin('aggregator_feed', 'af', 'ai.fid = af.fid');
    $query
      ->fields('ai');
    $query
      ->addExpression('af.title', 'feed_title');
    $query
      ->addExpression('ai.link', 'feed_LINK');
    $query
      ->condition('iid', $iid);
    $result = $query
      ->execute();
    $item->elements = array(
      array(
        'key' => 'pubDate',
        'value' => gmdate('r', $item->timestamp),
      ),
      array(
        'key' => 'dc:creator',
        'value' => $item->author,
      ),
      array(
        'key' => 'guid',
        'value' => $item->guid,
        'attributes' => array(
          'isPermaLink' => 'false',
        ),
      ),
    );
    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,
    ));
  }

}

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::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to it's output. 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
Rss::$base_field property
Rss::$base_table property
Rss::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
Rss::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides RowPluginBase::defineOptions
Rss::render function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render