class views_handler_field_user_mail

  1. 3.x modules/user/views_handler_field_user_mail.inc views_handler_field_user_mail
  2. 2.x modules/user/views_handler_field_user_mail.inc views_handler_field_user_mail

Field handler to provide acess control for the email field

Hierarchy

Expanded class hierarchy of views_handler_field_user_mail

2 string references to 'views_handler_field_user_mail'
user_views_data in modules/user.views.inc
Implementation of hook_views_data()
user_views_handlers in modules/user.views.inc
Implementation of hook_views_handlers() to register all of the basic handlers views uses.

File

modules/user/views_handler_field_user_mail.inc, line 5

View source
class views_handler_field_user_mail extends views_handler_field_user {
  function option_definition() {
    $options = parent::option_definition();
    $options['link_to_user'] = array('default' => 'mailto');
    return $options;
  }

  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['link_to_user'] = array(
      '#title' => t('Link this field'),
      '#type' => 'radios',
      '#options' => array(
        0 => t('No link'),
        'user' => t('To the user'),
        'mailto' => t("With a mailto:"),
      ),
      '#default_value' => $this->options['link_to_user'],
    );
  }

  function render($values) {
    if ($this->options['link_to_user'] == 'mailto') {
      return l($values->{$this->field_alias}, "mailto:" . $values->{$this->field_alias});
    }
    return $this->render_link(check_plain($values->{$this->field_alias}), $values);
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::accept_exposed_input function Take input from exposed filters 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::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 filter 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 filter form
views_handler::exposed_validate function Validate the exposed filter form
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
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_join function Get the join object that should be used for this handler.
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_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::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::options_validate function Validate the options form.
views_handler::pre_query function Run before the view is built.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
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_field::add_additional_fields function Add 'additional' fields to the query.
views_handler_field::add_self_tokens function Add any special tokens this field might use for itself.
views_handler_field::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render function Render a field using advanced settings.
views_handler_field::allow_advanced_render function Determine if this field can allow advanced rendering.
views_handler_field::click_sort function Called to determine what to tell the clicksorter.
views_handler_field::click_sortable function Determine if this field is click sortable.
views_handler_field::construct function Construct a new field handler. Overrides views_object::construct
views_handler_field::document_self_tokens function Document any special tokens this field might use for itself.
views_handler_field::element_type function Return DIV or SPAN based upon the field's element type.
views_handler_field::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
views_handler_field::label function Get this field's label.
views_handler_field::pre_render function Run before any fields are rendered.
views_handler_field::query function Called to add the field to a query. Overrides views_handler::query
views_handler_field::render_altered function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link function Render this field as a link, with the info from a fieldset set by the user.
views_handler_field::render_text function Perform an advanced text render for the item.
views_handler_field::render_trim_text function Trim the field down to the specified length.
views_handler_field::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
views_handler_field::theme_functions function
views_handler_field_user::init function Override init function to provide generic option to link to user. Overrides views_handler_field::init
views_handler_field_user::render_link function
views_handler_field_user_mail::options_form function Provide link to node option Overrides views_handler_field_user::options_form
views_handler_field_user_mail::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field_user::option_definition
views_handler_field_user_mail::render function Render the field. Overrides views_handler_field_user::render
views_object::destroy function
views_object::options 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::_set_option_defaults function