class views_handler_field_user_roles

Same name in other branches

7.x-3.x modules/user/views_handler_field_user_roles.inc \views_handler_field_user_roles

Field handler to provide a list of roles.

Hierarchy

class \views_object
- class \views_handler extends \views_object
  - class \views_handler_field extends \views_handler
    - class \views_handler_field_prerender_list extends \views_handler_field
      - class \views_handler_field_user_roles extends \views_handler_field_prerender_list

Expanded class hierarchy of views_handler_field_user_roles

File

modules/user/views_handler_field_user_roles.inc, line 7

View source

class views_handler_field_user_roles extends views_handler_field_prerender_list {
    function construct() {
        parent::construct();
        $this->additional_fields['uid'] = array(
            'table' => 'users',
            'field' => 'uid',
        );
    }
    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) {
            $result = db_query("SELECT u.uid, u.rid, r.name FROM {role} r INNER JOIN {users_roles} u ON u.rid = r.rid WHERE u.uid IN (" . implode(', ', $uids) . ") ORDER BY r.name");
            while ($role = db_fetch_object($result)) {
                $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 ID 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

Title Sort descending	Object type	Summary	Overriden Title	Overrides
views_handler::$handler_type	property	The type of the handler, for example filter/footer/field.
views_handler::$query	property	Where the $query object will reside:		6
views_handler::$view	property	The top object of a view.	Overrides views_object::$view
views_handler::accept_exposed_input	function	Take input from exposed handlers and assign to this handler, if necessary.		1
views_handler::access	function	Check whether current user has access to this handler.		6
views_handler::broken	function	Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.		6
views_handler::can_expose	function	Determine if a handler can be exposed.		2
views_handler::ensure_my_table	function	Ensure the main table for this handler is in the query. This is used a lot.		8
views_handler::exposed_form	function	Render our chunk of the exposed handler form when selecting		2
views_handler::exposed_info	function	Get information about the exposed form for the form renderer.		1
views_handler::exposed_submit	function	Submit the exposed handler form
views_handler::exposed_validate	function	Validate the exposed handler form		4
views_handler::expose_form	function	Overridable form for exposed handler options.
views_handler::expose_form_left	function			2
views_handler::expose_form_right	function			2
views_handler::expose_options	function	Set new exposed option defaults when exposed setting is flipped on.		2
views_handler::expose_submit	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate	function	Validate the options form.		1
views_handler::extra_options	function	Provide defaults for the handler.
views_handler::extra_options_form	function	Provide a form for setting options.		1
views_handler::extra_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.
views_handler::extra_options_validate	function	Validate the options form.
views_handler::get_field	function	Shortcut to get a handler's raw field value.
views_handler::get_join	function	Get the join object that should be used for this handler.
views_handler::has_extra_options	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.		1
views_handler::is_exposed	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin	function	Determine if the argument needs a style plugin.		1
views_handler::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.		4
views_handler::options_validate	function	Validate the options form.		4
views_handler::pre_query	function	Run before the view is built.		1
views_handler::sanitize_value	function	Sanitize the value for output.
views_handler::set_relationship	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button	function	Shortcut to display the expose/hide button.
views_handler::show_expose_form	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	function	If set to remember exposed input in the session, store it there.		1
views_handler::ui_name	function	Return a string representing this handler's name in the UI.		10
views_handler::use_group_by	function	Provides the handler some groupby.		2
views_handler::validate	function	Validates the handler against the complete View.		1
views_handler_field::$additional_fields	property	Stores additional fields which get's added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases	property
views_handler_field::$field_alias	property
views_handler_field::add_additional_fields	function	Add 'additional' fields to the query.
views_handler_field::admin_summary	function	Provide extra data to the administration form	Overrides views_handler::admin_summary
views_handler_field::advanced_render	function	Render a field using advanced settings.
views_handler_field::click_sort	function	Called to determine what to tell the clicksorter.		1
views_handler_field::click_sortable	function	Determine if this field is click sortable.
views_handler_field::element_classes	function	Return the class of the field.
views_handler_field::element_label_classes	function	Return the class of the field's label.
views_handler_field::element_label_type	function	Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type	function	Return an HTML element based upon the field's element type.		2
views_handler_field::element_wrapper_classes	function	Return the class of the field's wrapper.
views_handler_field::element_wrapper_type	function	Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements	function	Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens	function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_value	function	Get the value that's supposed to be rendered.
views_handler_field::init	function	init the handler with necessary data.	Overrides views_handler::init	11
views_handler_field::label	function	Get this field's label.
views_handler_field::render_altered	function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link	function	Render this field as a link, with the info from a fieldset set by the user.
views_handler_field::render_text	function	Perform an advanced text render for the item.
views_handler_field::render_trim_text	function	Trim the field down to the specified length.
views_handler_field::theme	function	Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
views_handler_field::theme_functions	function
views_handler_field::tokenize_value	function	Replace a value with tokens from the last field.
views_handler_field_prerender_list::$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.
views_handler_field_prerender_list::allow_advanced_render	function	Determine if advanced rendering is allowed.	Overrides views_handler_field::allow_advanced_render
views_handler_field_prerender_list::get_items	function	Return an array of items for the field.
views_handler_field_prerender_list::options_form	function	Default options form that provides the label widget that all fields should have.	Overrides views_handler_field::options_form	2
views_handler_field_prerender_list::option_definition	function	Information about options for all kinds of purposes will be held here.	Overrides views_handler_field::option_definition	2
views_handler_field_prerender_list::render	function	Render the field.	Overrides views_handler_field::render
views_handler_field_prerender_list::render_items	function	Render all items in this field together.
views_handler_field_user_roles::add_self_tokens	function	Add any special tokens this field might use for itself.	Overrides views_handler_field::add_self_tokens
views_handler_field_user_roles::construct	function	Construct a new field handler.	Overrides views_handler_field::construct
views_handler_field_user_roles::document_self_tokens	function	Document any special tokens this field might use for itself.	Overrides views_handler_field::document_self_tokens
views_handler_field_user_roles::pre_render	function	Run before any fields are rendered.	Overrides views_handler_field::pre_render
views_handler_field_user_roles::query	function	Called to add the field to a query.	Overrides views_handler_field::query
views_handler_field_user_roles::render_item	function
views_object::$definition	property	Handler's definition
views_object::$options	property	Except for displays, options for the object will be held here.		1
views_object::destroy	function			2
views_object::export_option	function			1
views_object::export_options	function
views_object::options	function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.		1
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	function	Unpack a single option definition.
views_object::unpack_translatables	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	function

class views_handler_field_user_roles

Hierarchy

Related topics

File

Members

Search views 6.x-3.x

API Navigation

Breadcrumb

class views_handler_field_user_roles

Hierarchy

Related topics

File

Members

Search views 6.x-3.x

API Navigation