Skip to content
Name.php 3.37 KiB
Newer Older
 * Definition of Drupal\user\Plugin\views\field\Name.
use Drupal\views\Plugin\views\display\DisplayPluginBase;
/**
 * Field handler to provide simple renderer that allows using a themed user link.
 *
 * @ingroup views_field_handlers
   * Overrides \Drupal\user\Plugin\views\field\User::init().
   *
   * Add uid in the query so we can test for anonymous if needed.
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);

    if (!empty($this->options['overwrite_anonymous']) || !empty($this->options['format_username'])) {
      $this->additional_fields['uid'] = 'uid';
    }
  }

  protected function defineOptions() {
    $options = parent::defineOptions();

    $options['overwrite_anonymous'] = array('default' => FALSE, 'bool' => TRUE);
    $options['anonymous_text'] = array('default' => '', 'translatable' => TRUE);
    $options['format_username'] = array('default' => TRUE, 'bool' => TRUE);

    return $options;
  }

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

    $form['format_username'] = array(
      '#title' => t('Use formatted username'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['format_username']),
      '#description' => t('If checked, the username will be formatted by the system. If unchecked, it will be displayed raw.'),
    );
    $form['overwrite_anonymous'] = array(
      '#title' => t('Overwrite the value to display for anonymous users'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['overwrite_anonymous']),
      '#description' => t('Enable to display different text for anonymous users.'),
    );
    $form['anonymous_text'] = array(
      '#title' => t('Text to display for anonymous users'),
      '#type' => 'textfield',
      '#default_value' => $this->options['anonymous_text'],
      '#states' => array(
        'visible' => array(
          ':input[name="options[overwrite_anonymous]"]' => array('checked' => TRUE),
        ),
      ),
    );
  }

  protected function renderLink($data, ResultRow $values) {
    $account->uid = $this->getValue($values, 'uid');
    $account->name = $this->getValue($values);
    if (!empty($this->options['link_to_user']) || !empty($this->options['overwrite_anonymous'])) {
      if (!empty($this->options['overwrite_anonymous']) && !$account->id()) {
        // This is an anonymous user, and we're overriting the text.
        return check_plain($this->options['anonymous_text']);
      }
      elseif (!empty($this->options['link_to_user'])) {
        $username = array(
          '#theme' => 'username',
          '#account' => $account,
        );
        return drupal_render($username);
      }
    }
    // If we want a formatted username, do that.
    if (!empty($this->options['format_username'])) {
      return user_format_name($account);
    }
    // Otherwise, there's no special handling, so return the data directly.
    return $data;
  }