You are here

Home » API reference » Views Tabs Field 7 » views_tabs_field_views_handler_field.inc

class views_tabs_field_views_handler_field in Views Tabs Field 7

A handler to provide tabbed output.

Hierarchy

Expanded class hierarchy of views_tabs_field_views_handler_field

1 string reference to 'views_tabs_field_views_handler_field'
views_tabs_field_views_data_alter in ./views_tabs_field.views.inc
Implements hook_views_data_alter().

File

./views_tabs_field_views_handler_field.inc, line 11
Definition of views_tabs_field_views_handler_field.

View source 
class views_tabs_field_views_handler_field extends views_handler_field {

  /**
   * {inheritdoc}
   */
  function query() {

    // No query to run.
  }

  /**
   * {inheritdoc}
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['tabs'] = array(
      'default' => array(),
      'bool' => FALSE,
    );
    $options['tabs_type'] = array(
      'default' => 'vertical_tabs',
      'bool' => FALSE,
    );
    return $options;
  }

  /**
   * {inheritdoc}
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Remove rewrite and link config.
    unset($form['alter']['alter_text']);
    unset($form['alter']['text']);
    unset($form['alter']['make_link']);
    unset($form['alter']['path']);
    unset($form['alter']['absolute']);
    unset($form['alter']['replace_spaces']);
    unset($form['alter']['external']);
    unset($form['alter']['path_case']);
    unset($form['alter']['link_class']);
    unset($form['alter']['alt']);
    unset($form['alter']['rel']);
    unset($form['alter']['prefix']);
    unset($form['alter']['suffix']);
    unset($form['alter']['target']);
    unset($form['alter']['trim']);
    unset($form['alter']['max_length']);
    unset($form['alter']['ellipsis']);
    unset($form['alter']['word_boundary']);
    unset($form['alter']['more_link']);
    unset($form['alter']['more_link_text']);
    unset($form['alter']['more_link_path']);

    //    $form['tabs']['help'] = $form['alter']['help'];
    //    unset($form['alter']['help']);
    $form['tabs_type'] = array(
      '#type' => 'select',
      '#title' => t('Type'),
      '#options' => array(
        'vertical_tabs' => t('Vertical tabs'),
      ),
      '#default_value' => $this->options['tabs_type'],
    );
    if ($info = element_info('horizontal_tabs')) {
      $form['tabs_type']['#options']['horizontal_tabs'] = t('Horizontal tabs');
    }
    $form['tabs'] = array(
      '#type' => 'fieldset',
      '#title' => t('Tabs'),
    );

    // Add form elements for each configured tab.
    foreach ($this->options['tabs'] as $delta => $tab) {
      $tab['delta'] = $delta;
      $form['tabs'][$delta] = $this
        ->add_tab($tab);
    }

    // Add a blank tab if no tabs exist.
    if (empty($this->options['tabs'])) {
      $form['tabs'][] = $this
        ->add_tab();
    }
    $form['tabs']['add'] = array(
      '#type' => 'submit',
      '#value' => t('Add tab'),
      '#op' => 'views_tabs_field_add',
      '#weight' => 9999,
      '#name' => drupal_html_id('views_tabs_field_add'),
    );
  }

  /**
   * {inheritdoc}
   */
  function options_submit(&$form, &$form_state) {
    parent::options_submit($form, $form_state);
    $trigger = $form_state['triggering_element'];
    if (isset($form_state['values']['options']['tabs']['add'])) {
      unset($form_state['values']['options']['tabs']['add']);
    }
    if (isset($trigger['#op'])) {
      switch ($trigger['#op']) {
        case 'views_tabs_field_add':
          $form_state['values']['options']['tabs'][] = array(
            'title' => '',
            'content' => '',
          );
          $form_state['rebuild'] = $form_state['rerender'] = TRUE;
          break;
        case 'views_tabs_field_remove':
          $form_state['rebuild'] = $form_state['rerender'] = TRUE;
          unset($form_state['values']['options']['tabs'][$trigger['#delta']]);
          break;
      }
    }
    $form_state['values']['options']['tabs'] = array_values($form_state['values']['options']['tabs']);
  }

  /**
   * Provide form inputs for configuring a tab.
   *
   * @param array $tab
   *   A tab declaration, keys "title" and "content". If empty, a "blank" tab
   *   will be provided.
   *
   * @return array
   *   FAPI form elements for configuring a tab.
   */
  public static function add_tab($tab = NULL) {
    $form_element = array(
      '#type' => 'fieldset',
    );
    $form_element['title'] = array(
      '#type' => 'textfield',
      '#title' => t('Title'),
    );
    $form_element['content'] = array(
      '#type' => 'textarea',
      '#title' => t('Content'),
    );

    // If we've got an "existing" tab, populate it.
    if ($tab) {
      $form_element['title']['#default_value'] = $tab['title'];
      $form_element['content']['#default_value'] = $tab['content'];

      // Add button to remove.
      $form_element['remove'] = array(
        '#type' => 'submit',
        '#value' => t('Remove'),
        '#op' => 'views_tabs_field_remove',
        '#delta' => $tab['delta'],
        '#name' => drupal_html_id('views_tabs_field_remove'),
      );
    }
    return $form_element;
  }

  /**
   * {inheritdoc}
   */
  function render($values) {
    switch ($this->options['tabs_type']) {
      case 'horizontal_tabs':
        $element = $this
          ->render_horizontal_tabs();
        break;
      default:
        $element = $this
          ->render_vertical_tabs();
    }
    return drupal_render($element);
  }

  /**
   * Render the field as vertical tabs.
   *
   * @return array
   *   Renderable array representing the tabs.
   */
  protected function render_vertical_tabs() {
    $element = array();
    $element['#type'] = 'vertical_tabs';
    $this->last_render = __FUNCTION__;
    foreach ($this->options['tabs'] as $delta => $config) {
      $tab = array();
      $tab['#type'] = 'fieldset';
      $tab['#title'] = $config['title'];

      // Rewrite.
      $alter['alter_text'] = TRUE;
      $alter['text'] = $config['content'];
      $alter['phase'] = VIEWS_HANDLER_RENDER_TEXT_PHASE_COMPLETELY;
      $tab['content']['#markup'] = $this
        ->render_text($alter);
      $tab['#group'] = 'tabs';
      $element['tab_' . $delta] = $tab;
    }
    $form_state = array();
    drupal_process_form('views_tabs_field', $element, $form_state);
    return $element;
  }

  /**
   * Render the field as horizontal tabs.
   *
   * @return array
   *   Renderable array representing the tabs.
   */
  protected function render_horizontal_tabs() {
    $element = array();
    $element['#type'] = 'horizontal_tabs';
    $element['#attached']['library'] = array(
      array(
        'field_group',
        'horizontal-tabs',
      ),
    );
    $this->last_render = __FUNCTION__;
    foreach ($this->options['tabs'] as $delta => $config) {
      $tab = array();
      $tab['#type'] = 'fieldset';
      $tab['#title'] = $config['title'];

      // Rewrite.
      $alter['alter_text'] = TRUE;
      $alter['text'] = $config['content'];
      $alter['phase'] = VIEWS_HANDLER_RENDER_TEXT_PHASE_COMPLETELY;
      $tab['content']['#markup'] = $this
        ->render_text($alter);
      $tab['#group'] = 'tabs';
      $element['tab_' . $delta] = $tab;
    }
    return $element;
  }

  /**
   * {inheritdoc}
   */
  function is_value_empty($value, $empty_zero, $no_skip_empty = TRUE) {

    // Always not empty.
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::add_self_tokens public function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
views_handler_field::click_sort public function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
views_handler_field::construct public function Construct a new field handler. Overrides views_object::construct 17
views_handler_field::document_self_tokens public function Document any special tokens this field might use for itself. 4
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value public function Get the value that's supposed to be rendered. 3
views_handler_field::init public function Init the handler with necessary data. Overrides views_handler::init 11
views_handler_field::label public function Get this field's label.
views_handler_field::pre_render public function Run before any fields are rendered. 8
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
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::destroy public function Destructor. 2
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_tabs_field_views_handler_field::add_tab public static function Provide form inputs for configuring a tab.
views_tabs_field_views_handler_field::is_value_empty function {inheritdoc} Overrides views_handler_field::is_value_empty
views_tabs_field_views_handler_field::options_form function {inheritdoc} Overrides views_handler_field::options_form
views_tabs_field_views_handler_field::options_submit function {inheritdoc} Overrides views_handler_field::options_submit
views_tabs_field_views_handler_field::option_definition function {inheritdoc} Overrides views_handler_field::option_definition
views_tabs_field_views_handler_field::query function {inheritdoc} Overrides views_handler_field::query
views_tabs_field_views_handler_field::render function {inheritdoc} Overrides views_handler_field::render
views_tabs_field_views_handler_field::render_horizontal_tabs protected function Render the field as horizontal tabs.
views_tabs_field_views_handler_field::render_vertical_tabs protected function Render the field as vertical tabs.