class views_plugin_argument_default_user

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

Default argument plugin to extract a user via menu_get_object.

Hierarchy

Expanded class hierarchy of views_plugin_argument_default_user

1 string reference to 'views_plugin_argument_default_user'

File

modules/user/views_plugin_argument_default_user.inc, line 11
Contains the user from URL argument default plugin.

View source
class views_plugin_argument_default_user extends views_plugin_argument_default {
  function option_definition() {
    $options = parent::option_definition();
    $options['user'] = array('default' => '', 'bool' => TRUE, 'translatable' => FALSE);

    return $options;
  }

  function options_form(&$form, &$form_state) {
    $form['user'] = array(
      '#type' => 'checkbox',
      '#title' => t('Also look for a node and use the node author'),
      '#default_value' => $this->options['user'],
    );
  }

  function convert_options(&$options) {
    if (!isset($options['user']) && isset($this->argument->options['default_argument_user'])) {
      $options['user'] = $this->argument->options['default_argument_user'];
    }
  }

  function get_argument() {
    foreach (range(1, 3) as $i) {
      $user = menu_get_object('user', $i);
      if (!empty($user)) {
        return $user->uid;
      }
    }

    foreach (range(1, 3) as $i) {
      $user = menu_get_object('user_uid_optional', $i);
      if (!empty($user)) {
        return $user->uid;
      }
    }

    if (!empty($this->options['user'])) {
      foreach (range(1, 3) as $i) {
        $node = menu_get_object('node', $i);
        if (!empty($node)) {
          return $node->uid;
        }
      }
    }

    if (arg(0) == 'user' && is_numeric(arg(1))) {
      return arg(1);
    }

    if (!empty($this->options['user'])) {
      if (arg(0) == 'node' && is_numeric(arg(1))) {
        $node = node_load(arg(1));
        if ($node) {
          return $node->uid;
        }
      }
    }

    // If the current page is a view that takes uid as an argument, return the uid.
    $view = views_get_page_view();

    if ($view && isset($view->argument['uid'])) {
      return $view->argument['uid']->argument;
    }
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
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
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::query function Add anything to the query that we might need to.
views_plugin::summary_title function Returns the summary of the settings in the display.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin::validate function Validate that the plugin is correct and can be saved.
views_plugin_argument_default::access function Determine if the administrator has the privileges to use this plugin
views_plugin_argument_default::check_access function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
views_plugin_argument_default::init function Initialize this plugin with the view and the argument it is linked to.
views_plugin_argument_default::options_submit function Provide the default form form for submitting options Overrides views_plugin::options_submit
views_plugin_argument_default::options_validate function Provide the default form form for validating options Overrides views_plugin::options_validate
views_plugin_argument_default_user::convert_options function Convert options from the older style. Overrides views_plugin_argument_default::convert_options
views_plugin_argument_default_user::get_argument function Return the default argument. Overrides views_plugin_argument_default::get_argument
views_plugin_argument_default_user::options_form function Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
views_plugin_argument_default_user::option_definition function Retrieve the options when this is a new access control plugin Overrides views_plugin_argument_default::option_definition