You are here

class User in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Views/user/Plugin/views/argument_default/User.php \Views\user\Plugin\views\argument_default\User
  2. 8.3 lib/Views/user/Plugin/views/argument_validator/User.php \Views\user\Plugin\views\argument_validator\User
  3. 8.3 lib/Views/user/Plugin/views/field/User.php \Views\user\Plugin\views\field\User

Default argument plugin to extract a user via menu_get_object.

Plugin annotation


@Plugin(
  id = "user",
  module = "user",
  title = @Translation("User ID from URL")
)

Hierarchy

Expanded class hierarchy of User

4 string references to 'User'
file_views_data in modules/file.views.inc
Implements hook_views_data().
node_views_data in modules/node.views.inc
Implements hook_views_data().
statistics_views_data in modules/statistics.views.inc
Implements hook_views_data().
user_views_data in modules/user.views.inc
Implements hook_views_data().

File

lib/Views/user/Plugin/views/argument_default/User.php, line 23
Definition of Views\user\Plugin\views\argument_default\User.

Namespace

Views\user\Plugin\views\argument_default
View source
class User extends ArgumentDefaultPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['user'] = array(
      'default' => '',
      'bool' => TRUE,
      'translatable' => FALSE,
    );
    return $options;
  }
  public function buildOptionsForm(&$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 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

Namesort descending Modifiers Type Description Overrides
ArgumentDefaultPluginBase::access public function Determine if the administrator has the privileges to use this plugin 1
ArgumentDefaultPluginBase::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.
ArgumentDefaultPluginBase::init public function Initialize this plugin with the view and the argument it is linked to. 1
ArgumentDefaultPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 1
ArgumentDefaultPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
User::buildOptionsForm public function Provide the default form for setting options. Overrides ArgumentDefaultPluginBase::buildOptionsForm
User::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides ArgumentDefaultPluginBase::defineOptions
User::get_argument function Return the default argument. Overrides ArgumentDefaultPluginBase::get_argument