class web_widgets_plugin_display_web_widgets in Web Widgets 7

Same name and namespace in other branches

6 views/web_widgets_plugin_display_web_widgets.inc \web_widgets_plugin_display_web_widgets

The plugin that handles a feed, such as RSS or atom.

For the most part, feeds are page displays but with some subtle differences.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_display
    class \views_plugin_display_page
    class \web_widgets_plugin_display_web_widgets

Expanded class hierarchy of web_widgets_plugin_display_web_widgets

1 string reference to 'web_widgets_plugin_display_web_widgets'

web_widgets_views_plugins in views/web_widgets.views.inc: Implements hook_views_plugins().

File

views/web_widgets_plugin_display_web_widgets.inc, line 13: Implementation of widget display.

View source

class web_widgets_plugin_display_web_widgets extends views_plugin_display_page {
  function has_path() {
    return TRUE;
  }
  function uses_breadcrumb() {
    return FALSE;
  }

  /**
   * web_widgets do not go through the normal page theming mechanism. Instead, they
   * go through their own little theme function and then return NULL so that
   * Drupal believes that the page has already rendered itself...which it has.
   */
  function execute() {
    $output = $this->view
      ->render();
    if (empty($output)) {
      return drupal_not_found();
    }
    print $output;
  }
  function preview() {
    return $this->view
      ->render();
  }

  /**
   * Instead of going through the standard views_view.tpl.php, delegate this
   * to the style handler.
   */
  function render() {

    // Ensure that the embed style functions are available
    $current_style = $this
      ->get_option('embed_style');
    $current_style = empty($current_style) ? 'iframe' : $current_style;
    require_once DRUPAL_ROOT . '/' . web_widgets_get_style_inc($current_style);

    // See if the render() function is "overloaded" or not
    web_widgets_inside_widget(TRUE);
    $render_func = 'web_widgets_' . $current_style . '_render';
    if (function_exists($render_func)) {
      $output = $render_func($this);
    }
    else {

      // Fallback to default way
      // TODO Please change this theme call to use an associative array for the $variables parameter.
      $content = theme($this
        ->theme_functions(), array(
        'view' => $this->view,
      ));
      $code = '';
      $track = $this
        ->get_option('track');
      if (!empty($track)) {

        // TODO Please change this theme call to use an associative array for the $variables parameter.
        $code = theme('web_widgets_tracking_code', $track);
      }
      $title = $this->view
        ->get_title();
      $output = web_widgets_render_widget($current_style, $code . $content, $title);
    }
    web_widgets_inside_widget(FALSE);
    return $output;
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['displays'] = array(
      'default' => array(),
    );

    // Overrides for standard stuff:
    $options['style_plugin']['default'] = 'rss';
    $options['style_options']['default'] = array(
      'mission_description' => FALSE,
      'description' => '',
    );
    $options['sitename_title']['default'] = FALSE;
    $options['row_plugin']['default'] = '';
    $options['defaults']['default']['style_plugin'] = 'views_plugin_style_list';
    $options['defaults']['default']['style_options'] = FALSE;
    $options['defaults']['default']['row_plugin'] = 'views_plugin_row_fields';
    $options['defaults']['default']['row_options'] = FALSE;

    // Extra display options:
    $options['embed_style']['default'] = 'iframe';
    $options['width']['default'] = 200;
    $options['height']['default'] = 200;
    $options['track']['default'] = NULL;
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {

    // It is very important to call the parent function here.
    parent::options_form($form, $form_state);
    switch ($form_state['section']) {
      case 'displays':
        $form['#title'] .= t('Attach embed code to');
        $displays = array();
        foreach ($this->view->display as $display_id => $display) {
          if (!empty($display->handler) && $display->handler
            ->accept_attachments()) {
            $displays[$display_id] = $display->display_title;
          }
        }
        $form['displays'] = array(
          '#type' => 'checkboxes',
          '#description' => t('The embed code will be displayed on the selected displays.'),
          '#options' => $displays,
          '#default_value' => $this
            ->get_option('displays'),
        );
        break;
      case 'dimension':
        $form['width'] = array(
          '#type' => 'textfield',
          '#description' => t('The width of the widget in pixels (not respected by all embed styles).'),
          '#default_value' => $this
            ->get_option('width'),
        );
        $form['height'] = array(
          '#type' => 'textfield',
          '#description' => t('The height of the widget in pixels (not respected by all embed styles).'),
          '#default_value' => $this
            ->get_option('height'),
        );
        break;
      case 'embed_style':
        $form['embed_style'] = array(
          '#type' => 'select',
          '#options' => web_widgets_get_styles(),
          '#description' => 'The method being used to embed a widget from this site in another site.',
          '#default_value' => $this
            ->get_option('embed_style'),
        );
        break;
      case 'path':
        $form['path']['#description'] = t('This view will be displayed by visiting this path on your site. It is recommended that the path be something like "path/%/%/widget" or "path/%/%/widget/[embed-style]", putting one % in the path for each argument you have defined in the view.');
        break;
      case 'track':
        $form['track'] = array(
          '#type' => 'textfield',
          '#default_value' => $this
            ->get_option('track'),
          '#description' => t('Supply a valid Analytics domain ID if you want to track the usage of the widget in the Google Analytics ecosystem. If the field is empty, the tracking is turned off.'),
        );
        break;
    }
  }

  /**
   * Perform any necessary changes to the form values prior to storage.
   * There is no need for this function to actually store the data.
   */
  function options_submit(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_submit($form, $form_state);
    switch ($form_state['section']) {
      case 'displays':
        $this
          ->set_option($form_state['section'], $form_state['values'][$form_state['section']]);
        $this
          ->set_option('attach_from', $form_state['view']->current_display);
        break;
      case 'dimension':
        $this
          ->set_option('width', $form_state['values']['width']);
        $this
          ->set_option('height', $form_state['values']['height']);
        break;
      case 'embed_style':
        $this
          ->set_option('embed_style', $form_state['values']['embed_style']);
        break;
      case 'track':
        $this
          ->set_option('track', $form_state['values']['track']);
        break;
    }
  }
  function options_summary(&$categories, &$options) {

    // It is very important to call the parent function here:
    parent::options_summary($categories, $options);

    // I don't think we want to give feeds menus directly.
    unset($options['menu']);
    $displays = array_filter($this
      ->get_option('displays'));
    if (count($displays) > 1) {
      $attach_to = t('Multiple displays');
    }
    else {
      if (count($displays) == 1) {
        $display = array_shift($displays);
        if (!empty($this->view->display[$display])) {
          $attach_to = $this->view->display[$display]->display_title;
        }
      }
    }
    if (!isset($attach_to)) {
      $attach_to = t('None');
    }
    $options['displays'] = array(
      'category' => 'page',
      'title' => t('Attach embed code to'),
      'value' => $attach_to,
    );
    $x = $this
      ->get_option('width');
    $y = $this
      ->get_option('height');
    if (!empty($x) && !empty($y)) {
      $dim = t("X: !x Y: !y", array(
        '!x' => $x,
        '!y' => $y,
      ));
    }
    else {
      $dim = t('Not set yet');
    }
    $options['dimension'] = array(
      'category' => 'page',
      'title' => t('Widget dimensions'),
      'value' => $dim,
    );
    $current_style = $this
      ->get_option('embed_style');

    // iframe is the default, built-in style, always available
    $current_style = empty($current_style) ? 'iframe' : $current_style;
    $style_names = web_widgets_get_styles();
    $options['embed_style'] = array(
      'category' => 'page',
      'title' => t('Embed style'),
      'value' => $style_names[$current_style],
    );
    $track = $this
      ->get_option('track');
    $track = empty($track) ? t('Tracking is turned off') : $track;
    $options['track'] = array(
      'category' => 'page',
      'title' => t('Google Tracking code'),
      'value' => $track,
    );
  }

  /**
   * Attach to another view.
   */
  function attach_to($display_id) {
    $attach_to = $this
      ->get_option('displays');
    if ($attach_to[$display_id]) {
      $current_style = $this
        ->get_option('embed_style');
      $current_style = empty($current_style) ? 'iframe' : $current_style;
      $variables['path'] = url($this->view
        ->get_url(NULL, $this
        ->get_path()), array(
        'absolute' => TRUE,
      ));
      $variables['width'] = $this
        ->get_option('width');
      $variables['height'] = $this
        ->get_option('height');
      $this->view->attachment_after .= web_widgets_render_embed_code($current_style, $variables);
    }
  }

  /**
   * Display validation.
   */
  function validate() {
    $errors = parent::validate();
    return $errors;
  }

}

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::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::defaultable_sections	public	function	List which sections are defaultable and what items each section contains.	1
views_plugin_display::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_display::displays_exposed	public	function	Determine if this display should display the exposed filters widgets.	1
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_style_type	public	function	Displays can require a certain type of style plugin.	1
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_exposed	public	function	Does this display uses exposed filters?	2
views_plugin_display::uses_exposed_form_in_block	public	function	Check to see if the display can put the exposed form in a block.
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_ajax	public	function	Does the display use AJAX?
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::options_validate	public	function	Validate the options form. Overrides views_plugin_display::options_validate
web_widgets_plugin_display_web_widgets::attach_to		function	Attach to another view. Overrides views_plugin_display::attach_to
web_widgets_plugin_display_web_widgets::execute		function	web_widgets do not go through the normal page theming mechanism. Instead, they go through their own little theme function and then return NULL so that Drupal believes that the page has already rendered itself...which it has. Overrides views_plugin_display_page::execute
web_widgets_plugin_display_web_widgets::has_path		function	The page display has a path. Overrides views_plugin_display_page::has_path
web_widgets_plugin_display_web_widgets::options_form		function	Provide the default form for setting options. Overrides views_plugin_display_page::options_form
web_widgets_plugin_display_web_widgets::options_submit		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_display_page::options_submit
web_widgets_plugin_display_web_widgets::options_summary		function	Provide the summary for page options in the views UI. Overrides views_plugin_display_page::options_summary
web_widgets_plugin_display_web_widgets::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_display_page::option_definition
web_widgets_plugin_display_web_widgets::preview		function	Fully render the display. Overrides views_plugin_display::preview
web_widgets_plugin_display_web_widgets::render		function	Instead of going through the standard views_view.tpl.php, delegate this to the style handler. Overrides views_plugin_display::render
web_widgets_plugin_display_web_widgets::uses_breadcrumb		function	Check to see if the display needs a breadcrumb. Overrides views_plugin_display_page::uses_breadcrumb
web_widgets_plugin_display_web_widgets::validate		function	Display validation. Overrides views_plugin_display_page::validate

You are here

class web_widgets_plugin_display_web_widgets in Web Widgets 7

Hierarchy

File

Members

API Navigation