You are here

Home » API reference » Views Atom 7 » views_plugin_style_atom_fields.inc

class views_plugin_style_atom_fields in Views Atom 7

Same name and namespace in other branches
  1. 6 views/views_plugin_style_atom_fields.inc \views_plugin_style_atom_fields

@file Style plugin for a standard Atom feed.

Hierarchy

Expanded class hierarchy of views_plugin_style_atom_fields

1 string reference to 'views_plugin_style_atom_fields'
views_atom_views_plugins in ./views_atom.views.inc
Implements hook_views_plugins().

File

./views_plugin_style_atom_fields.inc, line 8
Style plugin for a standard Atom feed.

View source 
class views_plugin_style_atom_fields extends views_plugin_style {

  /**
   * Initialize plugin.
   *
   * Set feed image for shared rendering later.
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options = NULL);

    //$this->feed_image = drupal_get_path('module', 'views_kml') . '/images/kml.png';
  }

  /**
   * Attach this view to another display as a feed.
   *
   * Provide basic functionality for all export style views like attaching a
   * feed image link.
   */
  function attach_to($display_id, $path, $title) {
    $url_options = array(
      'html' => true,
    );
    $image = theme('image', array(
      'path' => $this->feed_image,
    ));
    $this->view->feed_icon .= l($image, $path, $url_options);
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['entry_type'] = array(
      'default' => 'text',
    );
    $options['entry_type_custom'] = array(
      'default' => '',
    );
    $options['description']['feed_description'] = array(
      'default' => '',
    );
    $options['fields'] = array(
      'default' => array(),
    );
    $options['guid'] = array(
      // TODO determine what this variable is.
      'use_feed' => array(
        'default' => array(),
      ),
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = parent::option_definition();
    $handlers = $this->display->handler
      ->get_handlers('field');
    if (empty($handlers)) {
      $form['error_markup'] = array(
        '#value' => t('You need at least one field before you can configure your field settings'),
        '#prefix' => '<div class="error form-item description">',
        '#suffix' => '</div>',
      );
    }
    else {
      $form['entry_type'] = array(
        '#type' => 'select',
        '#title' => t('Entry type'),
        '#options' => drupal_map_assoc(array(
          'text',
          'html',
          'xhtml',
          'xml',
        )),
        '#default_value' => $this->options['entry_type'],
        '#description' => t('Select the media type of the content of each entry. If XML, enter the mimetype to use below.'),
      );
      $form['entry_type_custom'] = array(
        '#type' => 'textfield',
        '#title' => t('Custom entry type'),
        '#desctiption' => t('Enter the mimetype of the content of this feed.  It must be a valid XML mimetype.'),
        '#default_value' => $this->options['entry_type_custom'],
      );

      // Feed Description
      $form['description'] = array(
        '#type' => 'fieldset',
        '#title' => t('Feed Description'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      $form['description']['feed_description'] = array(
        '#type' => 'textarea',
        '#default_value' => $this->options['description']['feed_description'],
        '#description' => t('Description for this feed.  If left blank, the default site mission will be used.'),
      );

      // Field Chooser
      $field_names = array(
        '' => '--',
      );
      foreach ($handlers as $field => $handler) {
        if ($label = $handler
          ->label()) {
          $field_names[$field] = $label;
        }
        else {
          $field_names[$field] = $handler
            ->ui_name();
        }
      }
      $field_options = $this
        ->atom_mapping_fields();
      $form['fields'] = array(
        '#type' => 'fieldset',
        '#title' => t('Field usage'),
        '#description' => t('Atom needs certain elements have values. Specify which fields should be used to populate each field. Note that all fields will still be available to the content of the record.'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      foreach ($field_options as $k => $v) {
        $form['fields'][$k] = array(
          '#type' => 'select',
          '#title' => $v['label'],
          '#options' => $field_names,
          '#default_value' => $this->options['fields'][$k],
        );
      }

      // Feed Description
      $form['guid'] = array(
        '#type' => 'fieldset',
        '#title' => t('GUID settings'),
        '#description' => t('Controls how the GUID is created.'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      if (module_exists('feeds')) {
        $form['guid']['use_existing_from_feed'] = array(
          '#title' => t('Use existing GUID when available'),
          '#type' => 'checkbox',
          '#default_value' => !empty($this->options['guid']['use_existing_from_feed']),
          '#description' => t('If the node was imported into the site from another feed, use the original GUID.'),
        );
      }
      $form['guid']['#access'] = count(element_children($form['guid'])) ? TRUE : FALSE;
    }
  }

  /**
   * Keep track of what fields are mapped for reuse.
   */
  function atom_mapping_fields() {
    return array(
      'atom_title' => array(
        'label' => t('Title'),
        'required' => TRUE,
      ),
      'atom_summary' => array(
        'label' => t('Summary'),
      ),
      'atom_url' => array(
        'label' => t('URL'),
        'required' => TRUE,
      ),
      'atom_updated' => array(
        'label' => t('Updated'),
        'required' => TRUE,
      ),
      'atom_published' => array(
        'label' => t('Published'),
      ),
      'atom_author' => array(
        'label' => t('Author Name'),
      ),
      'atom_author_email' => array(
        'label' => t('Author Email'),
      ),
      'atom_author_url' => array(
        'label' => t('Author URL'),
      ),
    );
  }

  /**
   * Validate that the feed has all needed fields for atom to function.
   */
  function validate() {
    $errors = array();
    $fields = $this->display->handler
      ->get_handlers('field');
    $missing_fields = array();
    foreach ($this
      ->atom_mapping_fields() as $field_key => $info) {
      if (!empty($info['required']) && (empty($this->options['fields'][$field_key]) || empty($fields[$this->options['fields'][$field_key]]))) {
        $missing_fields[] = $info['label'];
      }
    }
    if (!empty($missing_fields)) {
      $errors[] = t('Display "@display" is missing required atom fields: @fields.', array(
        '@display' => $this->display->display_title,
        '@fields' => implode(', ', $missing_fields),
      ));
    }
    return $errors;
  }
  function map_rows($rows) {

    // Fields must be rendered in order as of Views 2.3, so we will pre-render everything.
    $renders = array();
    $keys = array_keys($this->view->field);
    foreach ($rows as $count => $row) {
      foreach ($keys as $id) {
        $renders[$count][$id] = $this->view->field[$id]
          ->theme($row);
      }
    }
    $items = array();
    foreach ($renders as $id => $row) {
      $item = array();
      foreach ($this->options['fields'] as $key => $val) {
        if (!isset($this->view->field[$val])) {
          continue;
        }
        $item[$key] = htmlentities($row[$val], ENT_QUOTES, '', FALSE);
      }
      $items[] = $item;
    }
    return $items;
  }

  /**
   * Override the parent render() method to check if this View is empty.
   *
   * @TODO, this override is useless without a new empty handler. The delete functionality
   * should be replicated there.
   */
  function render() {
    if (empty($this->view->result) && !$this->view->style_plugin
      ->even_empty()) {
      return $this->view->display_handler
        ->render_area('empty');
    }
    else {
      return parent::render();
    }
  }

}

Members

Namesort descending 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::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::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style_atom_fields::atom_mapping_fields function Keep track of what fields are mapped for reuse.
views_plugin_style_atom_fields::attach_to function Attach this view to another display as a feed.
views_plugin_style_atom_fields::init function Initialize plugin. Overrides views_plugin_style::init
views_plugin_style_atom_fields::map_rows function
views_plugin_style_atom_fields::options_form function Provide a form for setting options. Overrides views_plugin_style::options_form
views_plugin_style_atom_fields::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_plugin_style_atom_fields::render function Override the parent render() method to check if this View is empty. Overrides views_plugin_style::render
views_plugin_style_atom_fields::validate function Validate that the feed has all needed fields for atom to function. Overrides views_plugin_style::validate