class views_plugin_row_file_rss in File Entity (fieldable files) 7.2

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

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_file_rss

1 string reference to 'views_plugin_row_file_rss'

file_entity_views_plugins in ./file_entity.views.inc

Implements hook_views_plugins().

File

views/views_plugin_row_file_rss.inc, line 12

Contains the file RSS row style plugin.

class views_plugin_row_file_rss extends views_plugin_row {

  // 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
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_row::options_submit	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 views_plugin::options_submit	1
views_plugin_row::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::uses_fields	public	function
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 views_plugin_row::init
views_plugin_row_file_rss::options_form		function	Provide a form for setting options. Overrides views_plugin_row::options_form
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	Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
views_plugin_row_file_rss::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
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 views_plugin_row::render
views_plugin_row_file_rss::summary_title		function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title