class views_plugin_row_file_rss in File Entity (fieldable files) 8.2

Same name and namespace in other branches

7.3 views/views_plugin_row_file_rss.inc \views_plugin_row_file_rss
7.2 views/views_plugin_row_file_rss.inc \views_plugin_row_file_rss

Plugin which performs a file_view on the resulting object and formats it as an RSS item.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\row\RowPluginBase
    class \views_plugin_row_file_rss

Expanded class hierarchy of views_plugin_row_file_rss

File

views/views_plugin_row_file_rss.inc, line 13: Contains the file RSS row style plugin.

View source

class views_plugin_row_file_rss extends RowPluginBase {

  // Basic properties that let the row style follow relationships.
  var $base_table = 'file_managed';
  var $base_field = 'fid';

  // Stores the files loaded with pre_render.
  var $files = array();
  function option_definition() {
    $options = parent::option_definition();
    $options['item_length'] = array(
      'default' => 'default',
    );
    $options['links'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * Override init function to convert fulltext view-mode to full.
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);
    if ($this->options['item_length'] == 'fulltext') {
      $this->options['item_length'] = 'full';
    }
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['item_length'] = array(
      '#type' => 'select',
      '#title' => t('Display type'),
      '#options' => $this
        ->options_form_summary_options(),
      '#default_value' => $this->options['item_length'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }

  /**
   * Return the main options, which are shown in the summary title.
   */
  function options_form_summary_options() {
    $entity_info = entity_get_info('file');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    $options['title'] = t('Title only');
    $options['default'] = t('Use site default RSS settings');
    return $options;
  }
  function summary_title() {
    $options = $this
      ->options_form_summary_options();
    return check_plain($options[$this->options['item_length']]);
  }
  function pre_render($values) {
    $fids = array();
    foreach ($values as $row) {
      $fids[] = $row->{$this->field_alias};
    }
    if (!empty($fids)) {
      $this->files = file_load_multiple($fids);
    }
  }
  function render($row) {

    // For the most part, this code is taken from node_feed() in node.module
    global $base_url;
    $fid = $row->{$this->field_alias};
    if (!is_numeric($fid)) {
      return;
    }
    $display_mode = $this->options['item_length'];
    if ($display_mode == 'default') {
      $display_mode = variable_get('feed_item_length', 'teaser');
    }

    // Load the specified file:
    $file = $this->files[$fid];
    if (empty($file)) {
      return;
    }
    $item_text = '';
    $uri = entity_uri('file', $file);
    $user = user_load($file->uid);
    $file->link = url($uri['path'], $uri['options'] + array(
      'absolute' => TRUE,
    ));
    $file->rss_namespaces = array();
    $file->rss_elements = array(
      array(
        'key' => 'pubDate',
        'value' => gmdate('r', $file->timestamp),
      ),
      array(
        'key' => 'dc:creator',
        'value' => $user->name,
      ),
      array(
        'key' => 'guid',
        'value' => $file->fid . ' at ' . $base_url,
        'attributes' => array(
          'isPermaLink' => 'false',
        ),
      ),
    );

    // The file gets built and modules add to or modify $file->rss_elements
    // and $file->rss_namespaces.
    $build_mode = $display_mode;
    $build = file_view($file, $build_mode);
    unset($build['#theme']);
    if (!empty($file->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $file->rss_namespaces);
    }
    elseif (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;
    }

    // Hide the links if desired.
    if (!$this->options['links']) {
      hide($build['links']);
    }
    if ($display_mode != 'title') {

      // We render file contents and force links to be last.
      $build['links']['#weight'] = 1000;
      $item_text .= drupal_render($build);
    }
    $item = new stdClass();
    $item->description = $item_text;
    $item->title = $file->filename;
    $item->link = $file->link;
    $item->elements = $file->rss_elements;
    $item->fid = $file->fid;
    return theme($this
      ->theme_functions(), array(
      'view' => $this->view,
      'options' => $this->options,
      'row' => $item,
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	62
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. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate	6
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
RowPluginBase::$usesFields	protected	property	Does the row plugin support to add fields to its output.	4
RowPluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions	1
RowPluginBase::buildOptionsForm	public	function	Provide a form for setting options. Overrides PluginBase::buildOptionsForm	8
RowPluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions	8
RowPluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.	4
RowPluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	2
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	public	function	Returns the usesFields property.	4
RowPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm	1
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
views_plugin_row_file_rss::$base_field		property
views_plugin_row_file_rss::$base_table		property
views_plugin_row_file_rss::$files		property
views_plugin_row_file_rss::init		function	Override init function to convert fulltext view-mode to full. Overrides PluginBase::init
views_plugin_row_file_rss::options_form		function
views_plugin_row_file_rss::options_form_summary_options		function	Return the main options, which are shown in the summary title.
views_plugin_row_file_rss::option_definition		function
views_plugin_row_file_rss::pre_render		function	Allow the style to do stuff before each row is rendered.
views_plugin_row_file_rss::render		function	Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
views_plugin_row_file_rss::summary_title		function

You are here

class views_plugin_row_file_rss in File Entity (fieldable files) 8.2

Hierarchy

File

Members

API Navigation