class tripal_views_handler_area_action_links

  1. 2.x tripal_views/views/handlers/tripal_views_handler_area_action_links.inc tripal_views_handler_area_action_links
  2. 3.x tripal_chado_views/views/handlers/tripal_views_handler_area_action_links.inc tripal_views_handler_area_action_links

Provides an area for adding action links to a view.

Hierarchy

Expanded class hierarchy of tripal_views_handler_area_action_links

Related topics

Tripal Views Module
Provides functions for integrating chado with Drupal Views.
1 string reference to 'tripal_views_handler_area_action_links'
tripal_views_views_data in tripal_views/tripal_views.views.inc
Implements hook_views_data().

File

tripal_views/views/handlers/tripal_views_handler_area_action_links.inc, line 12
Contains tripal_views_handler_area_action_links Area Handler

View source
class tripal_views_handler_area_action_links extends views_handler_area {

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

    $options['link-1']['label-1'] = array('default' => '');
    $options['link-1']['path-1'] = array('default' => '');

    $options['link-2']['label-2'] = array('default' => '');
    $options['link-2']['path-2'] = array('default' => '');

    $options['link-3']['label-3'] = array('default' => '');
    $options['link-3']['path-3'] = array('default' => '');

    $options['link-4']['label-4'] = array('default' => '');
    $options['link-4']['path-4'] = array('default' => '');

    return $options;
  }

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

    $form['label']['#default_value'] = 'Action Links';

    $form['link-1'] = array(
      '#type' => 'fieldset',
      '#title' => t('Link #1')
    );

    $form['link-1']['label-1'] = array(
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#description' => t('The text that will be displayed as the link'),
      '#default_value' => $this->options['link-1']['label-1'],
    );

    $form['link-1']['path-1'] = array(
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#description' => t('The path that the link will link to'),
      '#default_value' => $this->options['link-1']['path-1']
    );

    $form['link-2'] = array(
      '#type' => 'fieldset',
      '#title' => t('Link #2')
    );

    $form['link-2']['label-2'] = array(
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#description' => t('The text that will be displayed as the link'),
      '#default_value' => $this->options['link-2']['label-2'],
    );

    $form['link-2']['path-2'] = array(
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#description' => t('The path that the link will link to'),
      '#default_value' => $this->options['link-2']['path-2']
    );

    $form['link-3'] = array(
      '#type' => 'fieldset',
      '#title' => t('Link #3')
    );

    $form['link-3']['label-3'] = array(
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#description' => t('The text that will be displayed as the link'),
      '#default_value' => $this->options['link-3']['label-3'],
    );

    $form['link-3']['path-3'] = array(
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#description' => t('The path that the link will link to'),
      '#default_value' => $this->options['link-3']['path-3']
    );

    $form['link-4'] = array(
      '#type' => 'fieldset',
      '#title' => t('Link #4')
    );

    $form['link-4']['label-4'] = array(
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#description' => t('The text that will be displayed as the link'),
      '#default_value' => $this->options['link-4']['label-4'],
    );

    $form['link-4']['path-4'] = array(
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#description' => t('The path that the link will link to'),
      '#default_value' => $this->options['link-4']['path-4']
    );

  }

  /**
   * {@inheritdoc}
   */
  function options_submit(&$form, &$form_state) {
    parent::options_submit($form, $form_state);
    //ddl($form_state, 'form state in submit');
    $this->options['link-1']['label-1'] = $form_state['values']['options']['link-1']['label-1'];
    $this->options['link-1']['path-1'] = $form_state['values']['options']['link-1']['path-1'];

    $this->options['link-2']['label-2'] = $form_state['values']['options']['link-2']['label-2'];
    $this->options['link-2']['path-2'] = $form_state['values']['options']['link-2']['path-2'];

    $this->options['link-3']['label-3'] = $form_state['values']['options']['link-3']['label-3'];
    $this->options['link-3']['path-3'] = $form_state['values']['options']['link-3']['path-3'];

    $this->options['link-4']['label-4'] = $form_state['values']['options']['link-4']['label-4'];
    $this->options['link-4']['path-4'] = $form_state['values']['options']['link-4']['path-4'];
  }

  /**
   * {@inheritdoc}
   */
  function render($empty = FALSE) {
    if (!$empty || !empty($this->options['empty'])) {
      $output = '<ul class="action-links">';

      // First link
      if (!empty($this->options['link-1']['label-1']) AND !empty($this->options['link-1']['path-1'])) {
        $output .= '<li>' . l($this->options['link-1']['label-1'], $this->options['link-1']['path-1']) . '</li>';
      }

      // Second link
      if (!empty($this->options['link-2']['label-2']) AND !empty($this->options['link-2']['path-2'])) {
        $output .= '<li>' . l($this->options['link-2']['label-2'], $this->options['link-2']['path-2']) . '</li>';
      }

      // Third link
      if (!empty($this->options['link-3']['label-3']) AND !empty($this->options['link-3']['path-3'])) {
        $output .= '<li>' . l($this->options['link-3']['label-3'], $this->options['link-3']['path-3']) . '</li>';
      }

      // Fourth link
      if (!empty($this->options['link-4']['label-4']) AND !empty($this->options['link-4']['path-4'])) {
        $output .= '<li>' . l($this->options['link-4']['label-4'], $this->options['link-4']['path-4']) . '</li>';
      }
      $output .= '</ul>';
      return $output;
    }
    return '';
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
tripal_views_handler_area_action_links::options_form function Default options form that provides the label widget that all fields should have. Overrides views_handler_area::options_form
tripal_views_handler_area_action_links::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_handler::options_submit
tripal_views_handler_area_action_links::option_definition function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides views_handler_area::option_definition
tripal_views_handler_area_action_links::render function Render the area Overrides views_handler_area::render
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary.
views_handler::access function Check whether current user has access to this handler.
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.
views_handler::can_expose function Determine if a handler can be exposed.
views_handler::case_transform function Transform a string by a certain method.
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting
views_handler::exposed_info function Get information about the exposed form for the form renderer.
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form
views_handler::expose_form function Form for exposed handler options.
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
views_handler::expose_submit 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 function Validate the options form.
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options.
views_handler::extra_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.
views_handler::extra_options_validate function Validate the options form.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::groupby_form function Provide a form for aggregation settings.
views_handler::groupby_form_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.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
views_handler::is_a_group function Returns TRUE if the exposed filter works like a grouped filter.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::options_validate function Validate the options form.
views_handler::placeholder function Provides a unique placeholders for handlers.
views_handler::post_execute function Run after the view is executed, before the result is cached.
views_handler::pre_query function Run before the view is built.
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::validate function Validates the handler against the complete View.
views_handler_area::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_area::init function Overrides views_handler::init(). Overrides views_handler::init
views_handler_area::label function Get this field's label.
views_handler_area::query function Don't run a query
views_handler_area::use_group_by function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy function
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function