You are here

Home » API reference » Party 7 » party_plugin_display_party_piece.inc

class party_plugin_display_party_piece in Party 7

Same name and namespace in other branches
  1. 8.2 includes/views/party_plugin_display_party_piece.inc \party_plugin_display_party_piece

@file Views plugin for party pieces.

Hierarchy

Expanded class hierarchy of party_plugin_display_party_piece

1 string reference to 'party_plugin_display_party_piece'
party_views_plugins in includes/views/party.views.inc
Implements hook_views_plugins().

File

includes/views/party_plugin_display_party_piece.inc, line 6
Views plugin for party pieces.

View source 
class party_plugin_display_party_piece extends views_plugin_display {
  function option_definition() {
    $options = parent::option_definition();

    // @todo: we can't provide a usable default here because we don't have
    // access to the view or this display's ID (WTF?).
    // Hence add validation to prevent the view being saved with this default
    // unchanged.
    $options['party_piece_path'] = array(
      'default' => '',
    );
    $options['party_piece_label'] = array(
      'default' => 'Views',
    );

    // This is not set in the UI, but here for documentation.
    $options['data_set'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Provide the summary for page options in the views UI.
   *
   * This output is returned as an array.
   */
  function options_summary(&$categories, &$options) {

    // It is very important to call the parent function here:
    parent::options_summary($categories, $options);
    $categories['party_piece'] = array(
      'title' => t('Party component'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    $options['party_piece_path'] = array(
      'category' => 'party_piece',
      'title' => t('Party component path'),
      'value' => 'party/%id/' . $this
        ->get_option('party_piece_path'),
    );
    $options['party_piece_label'] = array(
      'category' => 'party_piece',
      'title' => t('Party component label'),
      'value' => $this
        ->get_option('party_piece_label'),
    );
  }

  /**
   * 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 'party_piece_path':
        $form['#title'] .= t('Piece path');
        $form['party_piece_path'] = array(
          '#type' => 'textfield',
          '#required' => TRUE,
          '#title' => t("The path at which to show this component"),
          '#field_prefix' => 'party/%id/',
          '#default_value' => $this
            ->get_option('party_piece_path'),
        );
        break;
      case 'party_piece_label':
        $form['#title'] .= t('Piece label');
        $form['party_piece_label'] = array(
          '#type' => 'textfield',
          '#required' => TRUE,
          '#title' => t("The label for this component's tab"),
          '#default_value' => $this
            ->get_option('party_piece_label'),
        );
        break;
    }
  }
  function options_validate(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_validate($form, $form_state);

    // Only allow word characters and hyphens.
    // TODO: make this match accented characters.
    if (preg_match('/[^\\w-]/', $form_state['values']['party_piece_path'])) {
      form_error($form['party_piece_path'], t('The path may only contain letters, numbers, underscores, and hyphens.'));
    }

    // Check for duplicate paths.
    $pieces = party_get_party_piece_info();
    if (isset($pieces[$form_state['values']['party_piece_path']])) {
      form_error($form['party_piece_path'], t('The path already exists.'));
    }
  }
  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 'party_piece_path':

        // @todo: validate as proper path-y string. Can core menu help?
        // @todo: validate as not clashing with other paths on the party.
        $this
          ->set_option('party_piece_path', $form_state['values']['party_piece_path']);
        break;
      case 'party_piece_label':
        $this
          ->set_option('party_piece_label', $form_state['values']['party_piece_label']);
        break;
    }
  }

  /**
   * metacribbed from eva. may need work.
   * @todo this doesn't even seem to run!?!?!
   */
  function execute() {

    // Prior to this being called, the $view should already be set to this
    // display, and arguments should be set on the view.
    $this->view
      ->build();

    // And now render the view.
    return $this->view
      ->render();
  }

  /**
   * Returns items for hook_party_party_pieces().
   *
   * This is the same pattern as the block display plugin uses. It's neat ;)
   */
  function execute_hook_party_party_pieces() {
    $key = $this
      ->get_option('party_piece_path');

    // Build a piece to return.
    // Note that access settings are handled by party_party_party_pieces().
    $pieces = array(
      $key => array(
        'title' => $this
          ->get_option('party_piece_label'),
        'page callback' => 'party_page_view_piece_views',
        // We need to be able to find this view in the page callback.
        'page arguments' => array(
          1,
          $this->view->name,
          $this->display->id,
        ),
        'file' => 'party.pages.inc',
        // Add a key to say we came from a dataset. This is then handled by
        // party_party_party_pieces() which in turn enables local tasks for
        // adding entities within this set in party_menu_local_tasks_alter().
        'data_set' => $this->options['data_set'],
      ),
    );
    return $pieces;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
party_plugin_display_party_piece::execute function metacribbed from eva. may need work. @todo this doesn't even seem to run!?!?! Overrides views_plugin_display::execute
party_plugin_display_party_piece::execute_hook_party_party_pieces function Returns items for hook_party_party_pieces().
party_plugin_display_party_piece::options_form function Provide the default form for setting options. Overrides views_plugin_display::options_form
party_plugin_display_party_piece::options_submit function Perform any necessary changes to the form values prior to storage. Overrides views_plugin_display::options_submit
party_plugin_display_party_piece::options_summary function Provide the summary for page options in the views UI. Overrides views_plugin_display::options_summary
party_plugin_display_party_piece::options_validate function Validate the options form. Overrides views_plugin_display::options_validate
party_plugin_display_party_piece::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_display::option_definition
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::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_argument_text public function Provide some helpful text for the arguments. 1
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_pager_text public function Provide some helpful text for pagers. 1
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::has_path public function Check to see if the display has a 'path' field. 1
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::preview public function Fully render the display. 1
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 public function Render this display. 1
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_breadcrumb public function Check to see if the display needs a breadcrumb. 1
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::validate public function Make sure the display and all associated handlers are valid. Overrides views_plugin::validate 1
views_plugin_display::view_special_blocks public function Render any special blocks provided for this display.