class views_handler_field_comment in Views (for Drupal 7) 6.2
Same name and namespace in other branches
- 6.3 modules/comment/views_handler_field_comment.inc \views_handler_field_comment
- 7.3 modules/comment/views_handler_field_comment.inc \views_handler_field_comment
Field handler to allow linking to a comment
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler_field_comment
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field_comment
1 string reference to 'views_handler_field_comment'
- comment_views_data in modules/
comment.views.inc - Implementation of hook_views_data()
File
- modules/
comment/ views_handler_field_comment.inc, line 5
View source
class views_handler_field_comment extends views_handler_field {
/**
* Override init function to provide generic option to link to comment.
*/
function init(&$view, $options) {
parent::init($view, $options);
if (!empty($this->options['link_to_comment'])) {
$this->additional_fields['cid'] = 'cid';
$this->additional_fields['nid'] = 'nid';
}
}
function option_definition() {
$options = parent::option_definition();
$options['link_to_comment'] = array(
'default' => TRUE,
);
return $options;
}
/**
* Provide link-to-comment option
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['link_to_comment'] = array(
'#title' => t('Link this field to its comment'),
'#description' => t('This will override any other link you have set.'),
'#type' => 'checkbox',
'#default_value' => $this->options['link_to_comment'],
);
}
function render_link($data, $values) {
if (!empty($this->options['link_to_comment']) && $data !== NULL && $data !== '') {
$this->options['alter']['make_link'] = TRUE;
$this->options['alter']['path'] = "node/" . $values->{$this->aliases['nid']};
$this->options['alter']['fragment'] = "comment-" . $values->{$this->aliases['cid']};
}
return $data;
}
function render($values) {
return $this
->render_link(check_plain($values->{$this->field_alias}), $values);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
function | Take input from exposed filters and assign to this handler, if necessary. | 1 | |
views_handler:: |
function | Check whether current user has access to this handler. | 5 | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 5 | |
views_handler:: |
function | Determine if a handler can be exposed. | 1 | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | 7 | |
views_handler:: |
function | Render our chunk of the exposed filter form when selecting | 1 | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | 1 | |
views_handler:: |
function | Submit the exposed filter form | ||
views_handler:: |
function | Validate the exposed filter form | 4 | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | 1 | |
views_handler:: |
function | Provide defaults for the handler. | ||
views_handler:: |
function | Provide a form for setting options. | 1 | |
views_handler:: |
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:: |
function | Validate the options form. | ||
views_handler:: |
function | Get the join object that should be used for this handler. | ||
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | ||
views_handler:: |
function | Determine if the argument needs a style plugin. | 1 | |
views_handler:: |
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:: |
function | Validate the options form. | 1 | |
views_handler:: |
function | Run before the view is built. | 1 | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | ||
views_handler:: |
function | If set to remember exposed input in the session, store it there. | 1 | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | 5 | |
views_handler:: |
function | Validates the handler against the complete View. | ||
views_handler_field:: |
property | |||
views_handler_field:: |
property | |||
views_handler_field:: |
function | Add 'additional' fields to the query. | ||
views_handler_field:: |
function | Add any special tokens this field might use for itself. | 4 | |
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
||
views_handler_field:: |
function | Render a field using advanced settings. | ||
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | 1 | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | 1 | |
views_handler_field:: |
function | Determine if this field is click sortable. | ||
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
18 | |
views_handler_field:: |
function | Document any special tokens this field might use for itself. | 4 | |
views_handler_field:: |
function | Return DIV or SPAN based upon the field's element type. | 2 | |
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | ||
views_handler_field:: |
function | Get this field's label. | ||
views_handler_field:: |
function | Run before any fields are rendered. | 6 | |
views_handler_field:: |
function |
Called to add the field to a query. Overrides views_handler:: |
19 | |
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | ||
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | ||
views_handler_field:: |
function | Perform an advanced text render for the item. | ||
views_handler_field:: |
function | Trim the field down to the specified length. | ||
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | ||
views_handler_field:: |
function | |||
views_handler_field_comment:: |
function |
Override init function to provide generic option to link to comment. Overrides views_handler_field:: |
||
views_handler_field_comment:: |
function |
Provide link-to-comment option Overrides views_handler_field:: |
||
views_handler_field_comment:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
||
views_handler_field_comment:: |
function |
Render the field. Overrides views_handler_field:: |
||
views_handler_field_comment:: |
function | |||
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
views_object:: |
function | 2 | ||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | ||
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | ||
views_object:: |
function | 1 |