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'
user_views_plugins in modules/user.views.inc
Implementation of hook_views_plugins

File

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

View source
class views_plugin_argument_default_user extends views_plugin_argument_default {
  var $option_name = 'default_argument_user';

  function argument_form(&$form, &$form_state) {
    $form[$this->option_name] = array(
      '#type' => 'checkbox',
      '#title' => t('Also look for a node and use the node author'),
      '#default_value' => !empty($this->argument->options[$this->option_name]),
      '#process' => array('views_process_dependency'),
      '#dependency' => array(
        'radio:options[default_action]' => array('default'),
        'radio:options[default_argument_type]' => array($this->id)
      ),
      '#dependency_count' => 2,
    );
  }

  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->argument->options[$this->option_name])) {
      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->argument->options[$this->option_name])) {
      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.
    $views_page = views_get_page_view();

    if ($views_page && isset($views_page->view->argument['uid'])) {
      return $views_page->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::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::option_definition function Information about options for all kinds of purposes will be held here.
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
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_form function Provide a form to edit options for this plugin.
views_plugin::options_submit function Handle any special handling on the validate form.
views_plugin::options_validate function Validate the options form.
views_plugin::query function Add anything to the query that we might need to.
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. Overrides views_plugin::init
views_plugin_argument_default_user::argument_form function Overrides views_plugin_argument_default::argument_form
views_plugin_argument_default_user::get_argument function Return the default argument. Overrides views_plugin_argument_default::get_argument