class views_oai_pmh_plugin_display in Views OAI-PMH 7.3

The views_oai_pmh_plugin_display Class.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_display
      • class \views_plugin_display_page
        • class \views_oai_pmh_plugin_display

1 string reference to 'views_oai_pmh_plugin_display'

views_oai_pmh_views_plugins in ./views_oai_pmh.views.inc

Implements hook_views_plugins().

File

plugins/views_oai_pmh_plugin_display.inc, line 11

Contains the OAI-PMH display plugin.

class views_oai_pmh_plugin_display extends views_plugin_display_page {

  /**
   * {@inheritdoc}
   */
  public function get_style_type() {
    return 'views_oai_pmh';
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();

    // Overrides for standard stuff:
    $options['style_plugin']['default'] = 'views_oai_pmh_style';
    $options['defaults']['default']['style_plugin'] = FALSE;
    $options['defaults']['default']['style_options'] = FALSE;
    $options['row_plugin']['default'] = '';
    $options['defaults']['default']['row_plugin'] = FALSE;
    $options['defaults']['default']['row_options'] = FALSE;

    // Set default title.
    $options['title']['default'] = variable_get('site_name', 'OAI-PMH');
    $options['defaults']['default']['title'] = FALSE;
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_summary(&$categories, &$options) {
    parent::options_summary($categories, $options);

    // Replace the inherited 'Page settings' label.
    $categories['page']['title'] = t('OAI-PMH settings');

    // Replace the default title label.
    $categories['title']['title'] = t('Repository name');
    $options['title']['title'] = t('Repository name');

    // Remove features that do not seem to make sense here.
    unset($options['menu']);
    unset($options['exposed_form']);
    unset($categories['exposed']);
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    switch ($form_state['section']) {
      case 'title':
        $form['title']['#description'] = t("The repository name is given in response to OAI-PMH 'Identify' requests.");
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function uses_exposed() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function uses_exposed_form_in_block() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function displays_exposed() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function use_ajax() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function uses_breadcrumb() {
    return FALSE;
  }

  /**
   * Defaultable sections.
   *
   * Ensure that some settings are unique to this display. This is necessary
   * for settings that cannot be applied on the master display.
   */
  public function defaultable_sections($section = NULL) {
    $sections = parent::defaultable_sections();
    unset($sections['title']);
    unset($sections['style_plugin']);
    unset($sections['style_options']);
    if ($section) {
      if (!empty($sections[$section])) {
        return $sections[$section];
      }
    }
    else {
      return $sections;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {

    // Let the world know that this is the page view we're using.
    views_set_page_view($this->view);

    // And now render the view.
    $output = $this->view
      ->render();
    drupal_add_http_header('Content-Type', 'text/xml');
    print $output;
  }

  /**
   * Renders this display.
   *
   * Actually delegates rendering to the style plugin.
   */
  public function render() {
    return $this->view->style_plugin
      ->render($this->view->result);
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    return '<pre>' . check_plain($this->view
      ->render()) . '</pre>';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_oai_pmh_plugin_display::defaultable_sections	public	function	Defaultable sections. Overrides views_plugin_display::defaultable_sections
views_oai_pmh_plugin_display::displays_exposed	public	function	Determine if this display should display the exposed filters widgets. Overrides views_plugin_display::displays_exposed
views_oai_pmh_plugin_display::execute	public	function	The display page handler returns a normal view, but it also does a drupal_set_title for the page, and does a views_set_page_view on the view. Overrides views_plugin_display_page::execute
views_oai_pmh_plugin_display::get_style_type	public	function	Displays can require a certain type of style plugin. Overrides views_plugin_display::get_style_type
views_oai_pmh_plugin_display::options_form	public	function	Provide the default form for setting options. Overrides views_plugin_display_page::options_form
views_oai_pmh_plugin_display::options_summary	public	function	Provide the summary for page options in the views UI. Overrides views_plugin_display_page::options_summary
views_oai_pmh_plugin_display::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_display_page::option_definition
views_oai_pmh_plugin_display::preview	public	function	Fully render the display. Overrides views_plugin_display::preview
views_oai_pmh_plugin_display::render	public	function	Renders this display. Overrides views_plugin_display::render
views_oai_pmh_plugin_display::uses_breadcrumb	public	function	Check to see if the display needs a breadcrumb. Overrides views_plugin_display_page::uses_breadcrumb
views_oai_pmh_plugin_display::uses_exposed	public	function	Does this display uses exposed filters? Overrides views_plugin_display::uses_exposed
views_oai_pmh_plugin_display::uses_exposed_form_in_block	public	function	Check to see if the display can put the exposed form in a block. Overrides views_plugin_display::uses_exposed_form_in_block
views_oai_pmh_plugin_display::use_ajax	public	function	Does the display use AJAX? Overrides views_plugin_display::use_ajax
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_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::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::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_display::$extender	public	property	Stores all available display extenders.
views_plugin_display::$handlers	public	property	List of handlers for this display.
views_plugin_display::$view	public	property	The top object of a view. Overrides views_plugin::$view
views_plugin_display::accept_attachments	public	function	Can this display accept attachments?
views_plugin_display::access	public	function	Determine if the user has access to this display of the view.
views_plugin_display::attach_to	public	function	Allow displays to attach to other views.	2
views_plugin_display::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_display::export_handler	public	function	Special method to export items that have handlers.
views_plugin_display::export_option	public	function	Override of export_option() Overrides views_object::export_option
views_plugin_display::export_plugin	public	function	Special handling for plugin export.
views_plugin_display::export_style	public	function	Special handling for the style export.
views_plugin_display::format_themes	public	function	Format a list of theme templates for output by the theme info helper.
views_plugin_display::get_arguments_tokens	public	function	Returns to tokens for arguments.
views_plugin_display::get_field_labels	public	function	List of fields for the current display with the associated relationship.
views_plugin_display::get_handler	public	function	Get the handler object for a single handler.
views_plugin_display::get_handlers	public	function	Get a full array of handlers for $type. This caches them.
views_plugin_display::get_link_display	public	function	Check to see which display to use when creating links.
views_plugin_display::get_option	public	function	Intelligently get an option either from this or default display.
views_plugin_display::get_path	public	function	Return the base path to use for this display.
views_plugin_display::get_plugin	public	function	Get the instance of a plugin, for example style or row.
views_plugin_display::get_special_blocks	public	function	Provide the block system with any exposed widget blocks for this display.
views_plugin_display::get_url	public	function
views_plugin_display::hook_block_list	public	function	If this display creates a block, implement one of these.
views_plugin_display::hook_menu	public	function	If this display creates a page with a menu item, implement it here.
views_plugin_display::init	public	function		1
views_plugin_display::is_defaulted	public	function	Determine if a given option is set to use the default or current display.
views_plugin_display::is_default_display	public	function	If this display is the 'default' display which contains fallback settings.	1
views_plugin_display::is_identifier_unique	public	function	Check if the provided identifier is unique.
views_plugin_display::options_override	public	function	If override/revert was clicked, perform the proper toggle.
views_plugin_display::option_link	public	function	Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.
views_plugin_display::override_option	public	function	Set an option and force it to be an override.
views_plugin_display::pre_execute	public	function	Set up any variables on the view prior to execution.
views_plugin_display::query	public	function	Inject anything into the query that the display handler needs. Overrides views_plugin::query
views_plugin_display::render_area	public	function
views_plugin_display::render_empty	public	function
views_plugin_display::render_filters	public	function	Not all display plugins will support filtering.
views_plugin_display::render_footer	public	function	Render the footer of the view.
views_plugin_display::render_header	public	function	Render the header of the view.
views_plugin_display::render_more_link	public	function	Render the 'more' link.
views_plugin_display::render_pager	public	function	Not all display plugins will suppert pager rendering.	1
views_plugin_display::set_option	public	function	Intelligently set an option either from this display or from the default display, if directed to do so.
views_plugin_display::set_override	public	function	Flip the override setting for the given section.
views_plugin_display::unpack_handler	public	function	Special method to unpack items that have handlers.
views_plugin_display::unpack_plugin	public	function	Special handling for plugin unpacking.
views_plugin_display::unpack_style	public	function
views_plugin_display::uses_fields	public	function	Determine if the display's style uses fields.
views_plugin_display::uses_link_display	public	function	Check to see if the display has some need to link to another display.	1
views_plugin_display::use_group_by	public	function	Does the display have groupby enabled?
views_plugin_display::use_more	public	function	Does the display have a more link enabled?
views_plugin_display::use_more_always	public	function	Should the enabled display more link be shown when no more items?
views_plugin_display::use_more_open_new_window	public	function	Should the enabled display more link being opened in an new window?
views_plugin_display::use_more_text	public	function	Does the display have custom link text?
views_plugin_display::use_pager	public	function	Does the display have a pager enabled?	1
views_plugin_display::view_special_blocks	public	function	Render any special blocks provided for this display.
views_plugin_display_page::execute_hook_menu	public	function	Add this display's path information to Drupal's menu system.
views_plugin_display_page::get_argument_text	public	function	Provide some helpful text for the arguments. Overrides views_plugin_display::get_argument_text
views_plugin_display_page::get_pager_text	public	function	Provide some helpful text for pagers. Overrides views_plugin_display::get_pager_text
views_plugin_display_page::has_path	public	function	The page display has a path. Overrides views_plugin_display::has_path
views_plugin_display_page::options_submit	public	function	Perform any necessary changes to the form values prior to storage. Overrides views_plugin_display::options_submit	1
views_plugin_display_page::options_validate	public	function	Validate the options form. Overrides views_plugin_display::options_validate
views_plugin_display_page::validate	public	function	Make sure the display and all associated handlers are valid. Overrides views_plugin_display::validate