class views_plugin_row_fiafields in Facebook Instant Articles 7

Plugin which performs a node_view on the resulting object and formats it as an RSS item as per the Facebook Instant Article specification.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_fiafields

1 string reference to 'views_plugin_row_fiafields'

fb_instant_articles_views_views_plugins in modules/fb_instant_articles_views/views/fb_instant_articles_views.views.inc

Implements hook_views_plugins().

File

modules/fb_instant_articles_views/views/plugins/views_plugin_row_fiafields.inc, line 12

Contains views_plugin_row_fiafields.

class views_plugin_row_fiafields extends views_plugin_row {

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

  // Stores the nodes loaded with pre_render.
  var $nodes = array();

  /**
   * Add to the base class' options for the row.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['view_mode'] = array(
      'fb_instant_article' => 'fb_instant_article',
    );
    return $options;
  }

  /**
   * Alter the options form for the row to add our options.
   *
   * @param array $form
   * @param array $form_state
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['view_mode'] = array(
      '#type' => 'select',
      '#title' => t('View mode'),
      '#options' => $this
        ->options_form_summary_options(),
      '#default_value' => $this->options['view_mode'],
    );
  }

  /**
   * Helper function to return a list of available view modes for use in the
   * row settings.
   */
  function options_form_summary_options() {
    $entity_info = entity_get_info('node');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  function summary_title() {
    $options = $this
      ->options_form_summary_options();
    return check_plain($options[$this->options['view_mode']]);
  }

  /**
   * {@inheritdoc}
   */
  function pre_render($values) {
    $nids = array();
    foreach ($values as $row) {
      $nids[] = $row->{$this->field_alias};
    }
    if (!empty($nids)) {
      $this->nodes = node_load_multiple($nids);
    }
  }

  /**
   * Render a row object.
   *
   * @return string
   *   The rendered output of a single row, used by the style plugin.
   */
  function render($row) {
    global $base_url;
    $nid = $row->{$this->field_alias};
    if (!is_numeric($nid)) {
      return;
    }

    // Load the specified node:
    $node = $this->nodes[$nid];
    if (empty($node)) {
      return;
    }
    $uri = entity_uri('node', $node);
    $node->link = url($uri['path'], $uri['options'] + array(
      'absolute' => TRUE,
    ));

    // Build output for node.
    $view_mode = $this->options['view_mode'];
    $node_view = node_view($node, $view_mode);
    $item = new stdClass();

    // Required elements
    $item->node = $node;
    $item->title = $node->title;
    $item->link = $node->link;
    $item->content = drupal_render($node_view);

    // Optional elements, modules and themes will have the chance to alter
    // these.
    $item->elements = array(
      'guid' => $node->nid . ' at ' . $base_url,
      'pubDate' => format_date($node->created, 'custom', 'c'),
      'author' => format_username($node),
    );

    // Add necessary namespace
    $this->view->style_plugin->namespaces['xmlns:content'] = 'http://purl.org/rss/1.0/modules/content/';
    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::init	public	function		2
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_fiafields::$base_field		property
views_plugin_row_fiafields::$base_table		property
views_plugin_row_fiafields::$nodes		property
views_plugin_row_fiafields::options_form		function	Alter the options form for the row to add our options. Overrides views_plugin_row::options_form
views_plugin_row_fiafields::options_form_summary_options		function	Helper function to return a list of available view modes for use in the row settings.
views_plugin_row_fiafields::option_definition		function	Add to the base class' options for the row. Overrides views_plugin_row::option_definition
views_plugin_row_fiafields::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
views_plugin_row_fiafields::render		function	Render a row object. Overrides views_plugin_row::render
views_plugin_row_fiafields::summary_title		function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title