You are here

Home » API reference » Signup 7 » signup_handler_field_signup_node_link.inc

class signup_handler_field_signup_node_link in Signup 7

Same name and namespace in other branches
  1. 6.2 views/handlers/signup_handler_field_signup_node_link.inc \signup_handler_field_signup_node_link
  2. 6 views/handlers/signup_handler_field_signup_node_link.inc \signup_handler_field_signup_node_link

Field handler to generate links to the various signup subtabs on a node.

Hierarchy

Expanded class hierarchy of signup_handler_field_signup_node_link

1 string reference to 'signup_handler_field_signup_node_link'
signup_views_data in views/signup.views.inc
Implements hook_views_data().

File

views/handlers/signup_handler_field_signup_node_link.inc, line 5

View source 
class signup_handler_field_signup_node_link extends views_handler_field_node_link {
  function construct() {
    parent::construct();
    $this->additional_fields['uid'] = array(
      'table' => 'node',
      'field' => 'uid',
    );
    $this->additional_fields['nid'] = array(
      'table' => 'node',
      'field' => 'nid',
    );
    $this->additional_fields['signup_status'] = array(
      'table' => 'signup',
      'field' => 'status',
    );
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['tab'] = array(
      'default' => '',
    );
    $options['destination'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['tab'] = array(
      '#type' => 'select',
      '#title' => t('Signup tab to link to'),
      '#options' => array(
        'signup' => t('Signup current user form'),
        'list' => t('Signup user list'),
        'admin' => t('Administer signups'),
        'settings' => t('Signup settings'),
        'add' => t('Form to sign up other users'),
        'broadcast' => t('Signup broadcast form'),
      ),
      '#default_value' => $this->options['tab'],
    );
    $form['destination'] = array(
      '#type' => 'checkbox',
      '#title' => t('Set view as return destination'),
      '#description' => t('After submitting a form, do you want to be redirected back to this view, or stay at the other page?'),
      '#default_value' => $this->options['destination'],
    );
  }
  function render($values) {
    $tab = $this->options['tab'];
    $node = new stdClass();
    $node->nid = $values->{$this->aliases['nid']};
    $node->uid = $values->{$this->aliases['uid']};
    $node->signup_status = $values->{$this->aliases['signup_status']};
    $node->signup = isset($values->{$this->aliases['signup_status']});

    // Ensure the current user can access this link for the given node.
    if (!$this
      ->check_access($node, $tab)) {
      return;
    }
    $text = !empty($this->options['text']) ? $this->options['text'] : $this
      ->get_default_link_text($tab);
    $link_options = array();
    $url = $this
      ->get_url($node, $tab, $link_options);
    if ($tab != 'list' && !empty($this->options['destination'])) {
      $link_options['query'] = drupal_get_destination();
    }
    return l($text, $url, $link_options);
  }
  function get_default_link_text($tab) {
    switch ($tab) {
      case 'signup':
        return t('signup form');
      case 'list':
        return t('signup list');
      case 'admin':
        return t('administer signups');
      case 'settings':
        return t('signup settings');
      case 'add':
        return t('signup other users');
      case 'broadcast':
        return t('signup broadcast');
    }
  }
  function check_access($node, $tab) {
    switch ($tab) {
      case 'signup':

        // Slightly complicated, since _signup_menu_access() is testing if we
        // want the signup tab, but here we just want to know if the user can
        // signup at all.
        return user_access('sign up for content') && _signup_needs_output($node) && variable_get('signup_form_location', 'node') != 'none';
      case 'list':

        // Also can't use _signup_menu_access() since we don't have to assume
        // a tab for this access check.
        $view_all = user_access('view all signups');
        $admin = _signup_menu_access($node, 'admin');
        return ($view_all || $admin) && _signup_needs_output($node);
      case 'settings':

        // There's no separate check for this, it just assumes 'admin' acces.
        return _signup_menu_access($node, 'admin');
      default:

        // All the other tabs can just use _signup_menu_access() directly.
        return _signup_menu_access($node, $tab);
    }
  }
  function get_url($node, $tab, &$link_options) {
    switch ($tab) {
      case 'signup':
        if (variable_get('signup_form_location', 'node') == 'node') {
          $link_options['fragment'] = 'signup';
          return "node/{$node->nid}";
        }
        break;
      case 'list':
        $user_list = variable_get('signup_display_signup_user_list', 'signup');
        if ($user_list == 'signup' || $user_list == 'embed-view') {
          $link_options['fragment'] = 'signup';
          return "node/{$node->nid}";
        }
        break;
    }

    // If we didn't already special-case the URL, we know it's just a subtab
    // on the "signups" tab for the node.
    return "node/{$node->nid}/signups/{$tab}";
  }

}

Members

Namesort descending Modifiers Type Description Overrides
signup_handler_field_signup_node_link::check_access function
signup_handler_field_signup_node_link::construct function Construct a new field handler. Overrides views_handler_field::construct
signup_handler_field_signup_node_link::get_default_link_text function
signup_handler_field_signup_node_link::get_url function
signup_handler_field_signup_node_link::options_form function Default options form provides the label widget that all fields should have. Overrides views_handler_field_node_link::options_form
signup_handler_field_signup_node_link::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field_node_link::option_definition
signup_handler_field_signup_node_link::render function Render the field. Overrides views_handler_field_node_link::render
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::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::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
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_handler_field_entity::$base_field public property The base field of the entity type assosiated with this field.
views_handler_field_entity::$entities public property Stores all entites which are in the result.
views_handler_field_entity::$entity_type public property Stores the entity type which is loaded by this field.
views_handler_field_entity::get_value public function Return the entity object or a certain property of the entity. Overrides views_handler_field::get_value
views_handler_field_entity::init public function Initialize the entity type. Overrides views_handler_field::init
views_handler_field_entity::pre_render public function Load the entities for all rows that are about to be displayed. Overrides views_handler_field::pre_render
views_handler_field_entity::query public function Overriden to add the field for the entity id. Overrides views_handler_field::query 2
views_handler_field_node_link::render_link public function 4
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