You are here

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

class views_oai_pmh_plugin_style_auto in Views OAI-PMH 7.2

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

Hierarchy

Expanded class hierarchy of views_oai_pmh_plugin_style_auto

1 string reference to 'views_oai_pmh_plugin_style_auto'
views_oai_pmh_views_plugins in ./views_oai_pmh.views.inc
Implementation of hook_views_plugins().

File

plugins/views_oai_pmh_plugin_style_auto.inc, line 10
Definition of the views_oai_pmh_plugin_style_auto class.

View source 
class views_oai_pmh_plugin_style_auto extends views_oai_pmh_plugin_style {

  /**
   * An array of views_oai_pmh_plugin_style_misc objects, one for each metadata type.
   * @var views_oai_pmh_plugin_style_misc
   */
  private $_style_objects = array();

  /**
   * A flag indicating if the $_style_objects property is populated with objects.
   * @var bool
   */
  private $_style_objects_populated = FALSE;

  /**
   * A private copy of the currently-selected OAI metadataPrefix.
   * @var type
   */
  private $_metadata_format = '';
  public function __construct() {

    // Create a new object for each type of metadata class and store it in our _row_objects array.
    foreach ($GLOBALS['views_oai_pmh'] as $key => $metadata_config) {
      $this->_style_objects[$metadata_config->metadata_prefix] = new views_oai_pmh_plugin_style_misc();

      // Call the object's custom constructor function, passing it the $key as the type of metadata we want it to represent.
      $this->_style_objects[$metadata_config->metadata_prefix]
        ->construct($key);
    }
  }

  /**
   * Clones this object's properties into its style objects. Only performs this
   * action the first time the function is called; subsequent calls just run the
   * validity test.
   *
   * @return boolean TRUE if the objects are OK, FALSE if not.
   */
  private function _check_style_objects() {

    // Check to see if the $_style_objects array has not been populated already.
    if (!$this->_style_objects_populated) {

      // We'll use these two variables to determine the metadata type to use:
      // 1) The "metadataPrefix" parameter from the query string.
      $metadata_prefix = array_key_exists('metadataPrefix', $_GET) && $_GET['metadataPrefix'] != '' ? $_GET['metadataPrefix'] : '';

      // 2) The active row plugin from the View.
      $row_plugin = $this->view->display[$this->view->current_display]->handler->options['row_plugin'];

      // If we're set to use the Auto row plugin, then use the metadataPrefix parameter from the query string.
      if ($row_plugin == 'auto' && array_key_exists($metadata_prefix, $GLOBALS['views_oai_pmh'])) {
        $this->_metadata_format = $metadata_prefix;
      }
      elseif ($row_plugin != '' && $row_plugin != 'auto') {

        // Check each data definition for the correct metadata prefix to use with this row plugin.
        foreach ($GLOBALS['views_oai_pmh'] as $data_definition) {
          if ($data_definition->row_plugin == $row_plugin) {
            $this->_metadata_format = $data_definition->metadata_prefix;
          }
        }
      }
      else {
        $this->_metadata_format = $GLOBALS['views_oai_pmh_default'];
      }

      // Examine each value in the array of style objects, indexed by the keys from the global array of OAI data types.
      foreach ($GLOBALS['views_oai_pmh'] as $key => $unused) {

        // Populate each style object with the properties of this 'Auto' object.
        foreach ($this as $property => $value) {
          switch ($property) {

            // Don't apply the properties that are unique to the 'Auto' class.
            case '_style_objects':
            case '_style_objects_populated':
            case '_metadata_format':
              break;

            // Create/set the property in the row object.
            default:
              $this->_style_objects[$key]->{$property} = $value;
              break;
          }
        }
      }

      // Flag the object population code as complete so this block doesn't run again.
      $this->_style_objects_populated = TRUE;
    }

    // Check each individual array item for a valid object that is a descendant of the 'views_oai_pmh_plugin_style' class, returning a failure if we encounter any errors.
    foreach ($this->_style_objects as $obj) {
      if (!is_object($obj) || get_parent_class($obj) != 'views_oai_pmh_plugin_style') {
        return FALSE;
      }
    }
    return TRUE;
  }
  function render_records() {
    if ($this
      ->_check_style_objects()) {

      // Call render_records() on the appropriate object in the $_style_objects array.
      $records = $this->_style_objects[$this->_metadata_format]
        ->render_records();
      return $records;
    }
    return NULL;
  }

}

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_auto::$_metadata_format private property A private copy of the currently-selected OAI metadataPrefix.
views_oai_pmh_plugin_style_auto::$_style_objects private property An array of views_oai_pmh_plugin_style_misc objects, one for each metadata type.
views_oai_pmh_plugin_style_auto::$_style_objects_populated private property A flag indicating if the $_style_objects property is populated with objects.
views_oai_pmh_plugin_style_auto::render_records function
views_oai_pmh_plugin_style_auto::_check_style_objects private function Clones this object's properties into its style objects. Only performs this action the first time the function is called; subsequent calls just run the validity test.
views_oai_pmh_plugin_style_auto::__construct public 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::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_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