You are here

Home » API reference » Views OAI-PMH 7.2 » views_oai_pmh_plugin_style_misc.inc

class views_oai_pmh_plugin_style_misc in Views OAI-PMH 7.2

Same name and namespace in other branches
  1. 6.2 plugins/views_oai_pmh_plugin_style_misc.inc \views_oai_pmh_plugin_style_misc

@file Definition of the views_oai_pmh_plugin_style_misc class.

Hierarchy

Expanded class hierarchy of views_oai_pmh_plugin_style_misc

File

plugins/views_oai_pmh_plugin_style_misc.inc, line 7
Definition of the views_oai_pmh_plugin_style_misc class.

View source 
class views_oai_pmh_plugin_style_misc extends views_oai_pmh_plugin_style {

  /**
   * The metadata type that the object represents, e.g. 'oai_dc' for Dublin Core.
   * @var string
   */
  private $_metadata_format = '';

  /**
   * Class constructor-like function. 'Views' calls this when it creates the
   * object. Takes a metadata format type, such as 'oai_dc' for Dublin Core, as
   * a parameter. This is used to grab the necessary details of the format
   * whenever required from the $GLOBALS['views_oai_pmh'] configuration array.
   * If the value is not provided, it will attempt to detect it automatically
   * from the query string.
   *
   * @param string $type The metadata format type.
   */
  public function construct($type = '') {
    if ($type) {

      // Save the given metadata format value.
      $this->_metadata_format = $type;
    }
    else {

      // See if a particular data type is being requested in the query string.
      $metadata_prefix = array_key_exists('metadataPrefix', $_GET) && $_GET['metadataPrefix'] != '' ? $_GET['metadataPrefix'] : '';
      if (array_key_exists($metadata_prefix, $GLOBALS['views_oai_pmh'])) {

        // Save the metadata format in this object's property.
        $this->_metadata_format = $metadata_prefix;
      }
      elseif (array_key_exists('#metadata_format', $this->definition) && $this->definition['#metadata_format'] != '') {

        // See if the selected data type contains the metadata format we need to use.
        $this->_metadata_format = $this->definition['#metadata_format'];
      }
    }
  }
  function render_records() {
    if (!empty($this->display->handler->oai_args['errors'])) {
      return '';
    }
    if ($this
      ->uses_row_plugin() && empty($this->row_plugin)) {
      vpr('views_plugin_style_default: Missing row plugin');
      return '';
    }
    $records = '';
    if ($this
      ->uses_row_plugin()) {
      $rows = array();
      foreach ($this->view->result as $row_index => $row) {
        $this->view->row_index = $row_index;

        // Render the individual row.
        $fields = $this->row_plugin
          ->render($row);

        // Theme the rendered row.
        $themed_record = theme($GLOBALS['views_oai_pmh'][$this->_metadata_format]->record_theme, array(
          'nid' => $row->nid,
          'node_changed' => $row->node_changed,
          'fields' => $fields,
        ));
        $records .= $themed_record;
      }
    }
    return $records;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_oai_pmh_plugin_style::$oai_args protected property
views_oai_pmh_plugin_style::get_field_id function Get the nid of the result at the given row index.
views_oai_pmh_plugin_style::render function Render the display in this style. Overrides views_plugin_style::render
views_oai_pmh_plugin_style::render_content function
views_oai_pmh_plugin_style::render_identifiers function
views_oai_pmh_plugin_style::theme_functions function Provide a full list of possible theme templates used by this style. Overrides views_plugin::theme_functions
views_oai_pmh_plugin_style_misc::$_metadata_format private property The metadata type that the object represents, e.g. 'oai_dc' for Dublin Core.
views_oai_pmh_plugin_style_misc::construct public function Class constructor-like function. 'Views' calls this when it creates the object. Takes a metadata format type, such as 'oai_dc' for Dublin Core, as a parameter. This is used to grab the necessary details of the format whenever… Overrides views_object::construct
views_oai_pmh_plugin_style_misc::render_records function
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::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_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::init public function Initialize a style plugin.
views_plugin_style::options_form public function Provide a form to edit options for this plugin. Overrides views_plugin::options_form 9
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition 8
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::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate