class views_plugin_row_user_view

A row plugin which renders a user account via user_view.

Hierarchy

class views_object
- class views_plugin
  - class views_plugin_row
    class views_plugin_row_user_view

Expanded class hierarchy of views_plugin_row_user_view

File

core/modules/user/views/views_plugin_row_user_view.inc, line 12: Contains the user view row plugin.

View source

class views_plugin_row_user_view extends views_plugin_row {
  var $base_table = 'users';
  var $base_field = 'uid';

  // Store the user accounts to be used for pre_render.
  var $users = array();

  function option_definition() {
    $options = parent::option_definition();
    $options['view_mode'] = array('default' => 'full');

    return $options;
  }

  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    $options = $this->options_form_summary_options();
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#title' => t('Display mode'),
      '#default_value' => $this->options['view_mode'],
    );
    $form['help']['#type'] = 'help';
    $form['help']['#markup'] = t("Display the user account using the standard user account view. It might be necessary to add a user-profile.tpl.php file in your themes template folder, because the default <a href=\"@user-profile-api-link\">user-profile</a> template doesn't show the username.", array('@user-profile-api-link' => url('https://docs.backdropcms.org/api/backdrop/core%21modules%21user%21templates%21user-profile.tpl.php/1')));
  }


  /**
   * Return the main options, which are shown in the summary title.
   */
  function options_form_summary_options() {
    $entity_info = entity_get_info('user');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    if (empty($options)) {
      $options = array(
        'full' => t('User account')
      );
    }

    return $options;
  }

  function summary_title() {
    $options = $this->options_form_summary_options();
    return check_plain($options[$this->options['view_mode']]);
  }

  function pre_render($values) {
    $uids = array();
    foreach ($values as $row) {
      $uids[] = $row->{$this->field_alias};
    }
    $this->users = user_load_multiple($uids);
  }

  function render($row) {
    $account = $this->users[$row->{$this->field_alias}];
    $account->view = $this->view;
    $build = user_view($account, $this->options['view_mode']);

    return backdrop_render($build);
  }
}

Members

Name	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 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	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		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::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_row::init		function	Initialize the row plugin.
views_plugin_row::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. Overrides views_plugin::options_submit
views_plugin_row::options_validate		function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query		function	Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::uses_fields		function
views_plugin_row_user_view::options_form		function	Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_user_view::options_form_summary_options		function	Return the main options, which are shown in the summary title.
views_plugin_row_user_view::option_definition		function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides views_plugin_row::option_definition
views_plugin_row_user_view::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
views_plugin_row_user_view::render		function	Render a row object. This usually passes through to a theme template of some form, but not always. Overrides views_plugin_row::render
views_plugin_row_user_view::summary_title		function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title

class views_plugin_row_user_view

Hierarchy

Related topics

File

Members