class views_handler_field_user_badges_user_uid in User Badges 7.3
Same name and namespace in other branches
- 6.2 views_handler_field_user_badges_user_uid.inc \views_handler_field_user_badges_user_uid
- 6 views_handler_field_user_badges_user_uid.inc \views_handler_field_user_badges_user_uid
- 7 views_handler_field_user_badges_user_uid.inc \views_handler_field_user_badges_user_uid
- 7.2 includes/views/views_handler_field_user_badges_user_uid.inc \views_handler_field_user_badges_user_uid
@file A handler to provide proper displays for user badges.
@author Heine Deelstra (Heine), http://drupal.org/user/17943 @author Richard Skinner (Likeless), http://drupal.org/user/310635
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of views_handler_field_user_badges_user_uid
1 string reference to 'views_handler_field_user_badges_user_uid'
- user_badges_views_data in includes/
views/ user_badges.views.inc - Implements hook_views_data().
File
- includes/
views/ views_handler_field_user_badges_user_uid.inc, line 11 - A handler to provide proper displays for user badges.
View source
class views_handler_field_user_badges_user_uid extends views_handler_field {
function render($values) {
//We'll be needing the uid
$uid = $values->{$this->field_alias};
switch ($this->options['appearance']) {
//For the text options, get the badge objects and format their names
case 'linked_text':
case 'unlinked_text':
$user_badges = user_badges_get_badges($uid);
//If we have no badges for the user, just return nothing.
if (count($user_badges) == 0) {
return '';
}
foreach ((array) $user_badges as $badge) {
if ($this->options['appearance'] == 'linked_text' && $badge->href) {
$badges[] = l($badge->name, $badge->href);
}
else {
$badges[] = check_plain($badge->name);
}
}
return implode($this->options['separator'], $badges);
//Send the array of badge objects to the custom theme function
case 'custom_theme':
$user_badges = user_badges_get_badges($uid);
return theme($this->options['theme'], array(
'badges' => $user_badges,
));
//This case is for everything else. It returns the normal themed badges.
default:
return user_badges_for_uid($uid);
}
}
//Our options initialisation
function option_definition() {
$options = parent::option_definition();
$options['appearance'] = 'badges';
$options['separator'] = ' ';
$options['theme'] = '';
return $options;
}
//Our options form
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['appearance'] = array(
'#title' => t('Appearance'),
'#description' => t('How the badges will appear.'),
'#type' => 'radios',
'#options' => array(
'badges' => t('Badges'),
'linked_text' => t('Linked Text'),
'unlinked_text' => t('Unlinked Text'),
'custom_theme' => t('Custom Theme'),
),
'#default_value' => $this->options['appearance'],
'#weight' => -3,
);
$form['separator'] = array(
'#title' => t('Text separator'),
'#description' => t('The string that will go between each badge name.'),
'#type' => 'textfield',
'#default_value' => $this->options['separator'],
'#size' => 6,
'#maxlength' => 128,
'#weight' => -2,
);
$form['theme'] = array(
'#title' => t('Custom Theme'),
'#description' => t('If you select "Custom Theme" above, enter the name of your theme here. It will be passed an array of badge objects.'),
'#type' => 'textfield',
'#default_value' => $this->options['theme'],
'#maxlength' => 128,
'#weight' => -1,
);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
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. | |
views_handler:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
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 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Validate the options form. | 4 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_field:: |
public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. | |
views_handler_field:: |
public | property | ||
views_handler_field:: |
public | property | ||
views_handler_field:: |
protected | property | Keeps track of the last render index. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. | |
views_handler_field:: |
public | function | Add 'additional' fields to the query. | |
views_handler_field:: |
public | function | Add any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
public | function | Render a field using advanced settings. | |
views_handler_field:: |
public | function | Determine if this field can allow advanced rendering. | 1 |
views_handler_field:: |
public | function | Called to determine what to tell the clicksorter. | 1 |
views_handler_field:: |
public | function | Determine if this field is click sortable. | 1 |
views_handler_field:: |
public | function |
Construct a new field handler. Overrides views_object:: |
17 |
views_handler_field:: |
public | function | Document any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function | Return the class of the field. | |
views_handler_field:: |
public | function | Return the class of the field's label. | |
views_handler_field:: |
public | function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
public | function | Return an HTML element based upon the field's element type. | 2 |
views_handler_field:: |
public | function | Return the class of the field's wrapper. | |
views_handler_field:: |
public | function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
public | function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
public | function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
public | function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
public | function | Get the value that's supposed to be rendered. | 3 |
views_handler_field:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
11 |
views_handler_field:: |
public | function | Checks if a field value is empty. | |
views_handler_field:: |
public | function | Get this field's label. | |
views_handler_field:: |
public | function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Run before any fields are rendered. | 8 |
views_handler_field:: |
public | function | Called to add the field to a query. | 22 |
views_handler_field:: |
public | function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
public | function | Render this field as a link, with info from a fieldset set by the user. | |
views_handler_field:: |
public | function | Perform an advanced text render for the item. | |
views_handler_field:: |
public | function | Trim the field down to the specified length. | |
views_handler_field:: |
public | function | Call out to the theme() function. | |
views_handler_field:: |
public | function | Build a list of suitable theme functions for this view. | |
views_handler_field:: |
public | function | Replace a value with tokens from the last field. | |
views_handler_field:: |
public | function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Determines if this field will be available as an option to group the result by in the style settings. | |
views_handler_field_user_badges_user_uid:: |
function |
Default options form provides the label widget that all fields should have. Overrides views_handler_field:: |
||
views_handler_field_user_badges_user_uid:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
||
views_handler_field_user_badges_user_uid:: |
function |
Render the field. Overrides views_handler_field:: |
||
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |