class Roles

Same name in this branch
  1. 9.x drupal/core/modules/user/lib/Drupal/user/Plugin/views/field/Roles.php \Drupal\user\Plugin\views\field\Roles
  2. 9.x drupal/core/modules/user/lib/Drupal/user/Plugin/views/filter/Roles.php \Drupal\user\Plugin\views\filter\Roles

Field handler to provide a list of roles.

Plugin annotation


@Plugin(
  id = "user_roles",
  module = "user"
)

Hierarchy

Expanded class hierarchy of Roles

Related topics

Views field handlers
Handlers to tell Views how to build and display fields.
7 string references to 'Roles'
AccountFormController::form in drupal/core/modules/user/lib/Drupal/user/AccountFormController.php
Overrides Drupal\Core\Entity\EntityFormController::form().
block_admin_configure in drupal/core/modules/block/block.admin.inc
Form constructor for the block configuration form.
filter_admin_format_form in drupal/core/modules/filter/filter.admin.inc
Form constructor for the text format add/edit form.
theme_filter_admin_overview in drupal/core/modules/filter/filter.admin.inc
Returns HTML for the text format administration overview form.
user_admin_account in drupal/core/modules/user/user.admin.inc
Form builder; User administration page.

... See full list

File

drupal/core/modules/user/lib/Drupal/user/Plugin/views/field/Roles.php, line 24
Definition of Drupal\user\Plugin\views\field\Roles.

Namespace

Drupal\user\Plugin\views\field
View source
class Roles extends PrerenderList {

  /**
   * Overrides Drupal\views\Plugin\views\field\FieldPluginBase::init().
   */
  public function init(ViewExecutable $view, &$options) {
    parent::init($view, $options);
    $this->additional_fields['uid'] = array(
      'table' => 'users',
      'field' => 'uid',
    );
  }
  public function query() {
    $this
      ->add_additional_fields();
    $this->field_alias = $this->aliases['uid'];
  }
  function pre_render(&$values) {
    $uids = array();
    $this->items = array();
    foreach ($values as $result) {
      $uids[] = $this
        ->get_value($result);
    }
    if ($uids) {
      $query = db_select('role', 'r');
      $query
        ->join('users_roles', 'u', 'u.rid = r.rid');
      $query
        ->addField('r', 'name');
      $query
        ->fields('u', array(
        'uid',
        'rid',
      ));
      $query
        ->condition('u.uid', $uids);
      $query
        ->orderBy('r.name');
      $result = $query
        ->execute();
      foreach ($result as $role) {
        $this->items[$role->uid][$role->rid]['role'] = check_plain($role->name);
        $this->items[$role->uid][$role->rid]['rid'] = $role->rid;
      }
    }
  }
  function render_item($count, $item) {
    return $item['role'];
  }
  function document_self_tokens(&$tokens) {
    $tokens['[' . $this->options['id'] . '-role' . ']'] = t('The name of the role.');
    $tokens['[' . $this->options['id'] . '-rid' . ']'] = t('The role machine-name of the role.');
  }
  function add_self_tokens(&$tokens, $item) {
    if (!empty($item['role'])) {
      $tokens['[' . $this->options['id'] . '-role' . ']'] = $item['role'];
      $tokens['[' . $this->options['id'] . '-rid' . ']'] = $item['rid'];
    }
  }

}

Members

Name Modifiers Type Descriptionsort descending Overrides
Roles::render_item function
PluginBase::setOptionDefaults protected function
FieldPluginBase::$field_alias property
FieldPluginBase::$aliases property
FieldPluginBase::add_additional_fields function Add 'additional' fields to the query.
Roles::add_self_tokens function Add any special tokens this field might use for itself. Overrides FieldPluginBase::add_self_tokens
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
FieldPluginBase::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
Roles::query public function Called to add the field to a query. Overrides FieldPluginBase::query
FieldPluginBase::click_sort function Called to determine what to tell the clicksorter. 1
HandlerBase::access public function Check whether current user has access to this handler. 6
FieldPluginBase::is_value_empty function Checks if a field value is empty.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
PrerenderList::buildOptionsForm public function Default options form that provides the label widget that all fields should have. Overrides FieldPluginBase::buildOptionsForm 1
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
PrerenderList::allow_advanced_render function Determine if advanced rendering is allowed. Overrides FieldPluginBase::allow_advanced_render
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
FieldPluginBase::click_sortable function Determine if this field is click sortable. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
FieldPluginBase::use_string_group_by function Determines if this field will be available as an option to group the result by in the style settings.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
Roles::document_self_tokens function Document any special tokens this field might use for itself. Overrides FieldPluginBase::document_self_tokens
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
FieldPluginBase::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
FieldPluginBase::get_entity function Get the entity matching the current row and relationship.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
FieldPluginBase::get_value function Get the value that's supposed to be rendered. 1
FieldPluginBase::label public function Get this field's label.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PrerenderList::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FieldPluginBase::defineOptions 1
PluginBase::$options public property Options for this plugin will be held here.
Roles::init public function Overrides Drupal\views\Plugin\views\field\FieldPluginBase::init(). Overrides FieldPluginBase::init
FieldPluginBase::render_text function Perform an advanced text render for the item.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
FieldPluginBase::submitOptionsForm public function Performs some cleanup tasks on the options array before saving it. Overrides HandlerBase::submitOptionsForm
PluginBase::$definition public property Plugins's definition
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
FieldPluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides PluginBase::themeFunctions
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
FieldPluginBase::get_elements function Provide a list of elements valid for field HTML.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
FieldPluginBase::adminSummary public function Provide extra data to the administration form Overrides HandlerBase::adminSummary
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
FieldPluginBase::get_token_values_recursive function Recursive function to add replacements for nested query string parameters.
FieldPluginBase::advanced_render function Render a field using advanced settings.
PrerenderList::render_items function Render all items in this field together.
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
FieldPluginBase::render function Render the field. 32
FieldPluginBase::render_as_link function Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::render_altered function Render this field as altered text, from a fieldset set by the user.
FieldPluginBase::tokenize_value function Replace a value with tokens from the last field.
FieldPluginBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel 1
PrerenderList::get_items function Return an array of items for the field.
FieldPluginBase::element_type function Return an HTML element based upon the field's element type. 1
FieldPluginBase::element_label_type function Return an HTML element for the label based upon the field's element type.
FieldPluginBase::element_wrapper_type function Return an HTML element for the wrapper based upon the field's element type.
FieldPluginBase::element_label_classes function Return the class of the field's label.
FieldPluginBase::element_wrapper_classes function Return the class of the field's wrapper.
FieldPluginBase::element_classes function Return the class of the field.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::usesOptions public function Returns the usesOptions property. 8
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
Roles::pre_render function Run before any fields are rendered. Overrides FieldPluginBase::pre_render
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
FieldPluginBase::$additional_fields property Stores additional fields which get's added to the query. The generated aliases are stored in $aliases.
PrerenderList::$items property Stores all items which are used to render the items. It should be keyed first by the id of the base table, for example nid. The second key is the id of the thing which is displayed multiple times per row, for example the tid.
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
FieldPluginBase::$original_value public property The field value prior to any rewriting.
PluginBase::$plugin_id protected property The plugin_id.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
PluginBase::$view public property The top object of a view. 1
HandlerBase::caseTransform protected function Transform a string by a certain method.
FieldPluginBase::render_trim_text function Trim the field down to the specified length.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 4
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$field public property With field you can override the realField if the real field is not set.