class views_plugin_row_comment_rss
Plugin which formats the comments as RSS items.
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_row extends \views_plugin
- class \views_plugin_row_comment_rss extends \views_plugin_row
- class \views_plugin_row extends \views_plugin
- class \views_plugin extends \views_object
Expanded class hierarchy of views_plugin_row_comment_rss
1 string reference to 'views_plugin_row_comment_rss'
- comment_views_plugins in modules/
comment.views.inc - Implements hook_views_plugins().
File
-
modules/
comment/ views_plugin_row_comment_rss.inc, line 11
View source
class views_plugin_row_comment_rss extends views_plugin_row {
/**
* {@inheritdoc}
*/
public $base_table = 'comment';
/**
* {@inheritdoc}
*/
public $base_field = 'cid';
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['item_length'] = array(
'default' => 'default',
);
$options['links'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
/**
* {@inheritdoc}
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['item_length'] = array(
'#type' => 'select',
'#title' => t('Display type'),
'#options' => $this->options_form_summary_options(),
'#default_value' => $this->options['item_length'],
);
$form['links'] = array(
'#type' => 'checkbox',
'#title' => t('Display links'),
'#default_value' => $this->options['links'],
);
}
/**
* {@inheritdoc}
*/
public function pre_render($result) {
$cids = array();
$nids = array();
foreach ($result as $row) {
$cids[] = $row->cid;
}
$this->comments = comment_load_multiple($cids);
foreach ($this->comments as &$comment) {
$comment->depth = count(explode('.', $comment->thread)) - 1;
$nids[] = $comment->nid;
}
unset($comment);
$this->nodes = node_load_multiple($nids);
}
/**
* Return the main options, which are shown in the summary title.
*
* @see views_plugin_row_node_rss::options_form_summary_options()
* @todo Maybe provide a views_plugin_row_rss_entity and reuse this method
* in views_plugin_row_comment|node_rss.inc
*/
public function options_form_summary_options() {
$entity_info = entity_get_info('node');
$options = array();
if (!empty($entity_info['view modes'])) {
foreach ($entity_info['view modes'] as $mode => $settings) {
$options[$mode] = $settings['label'];
}
}
$options['title'] = t('Title only');
$options['default'] = t('Use site default RSS settings');
return $options;
}
/**
* {@inheritdoc}
*/
public function render($row) {
global $base_url;
$cid = $row->{$this->field_alias};
if (!is_numeric($cid)) {
return;
}
$item_length = $this->options['item_length'];
if ($item_length == 'default') {
$item_length = variable_get('feed_item_length', 'teaser');
}
// Load the specified comment and its associated node.
$comment = $this->comments[$cid];
if (empty($comment) || empty($this->nodes[$comment->nid])) {
return;
}
$item_text = '';
$uri = entity_uri('comment', $comment);
$comment->link = url($uri['path'], $uri['options'] + array(
'absolute' => TRUE,
));
$comment->rss_namespaces = array();
$comment->rss_elements = array(
array(
'key' => 'pubDate',
'value' => gmdate('r', $comment->created),
),
array(
'key' => 'dc:creator',
'value' => format_username($comment),
),
array(
'key' => 'guid',
'value' => 'comment ' . $comment->cid . ' at ' . $base_url,
'attributes' => array(
'isPermaLink' => 'false',
),
),
);
// The comment gets built and modules add to or modify
// $comment->rss_elements and $comment->rss_namespaces.
$build = comment_view($comment, $this->nodes[$comment->nid], 'rss');
unset($build['#theme']);
if (!empty($comment->rss_namespaces)) {
$this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $comment->rss_namespaces);
}
// Hide the links if desired.
if (!$this->options['links']) {
hide($build['links']);
}
if ($item_length != 'title') {
// We render comment contents and force links to be last.
$build['links']['#weight'] = 1000;
$item_text .= drupal_render($build);
}
$item = new stdClass();
$item->description = $item_text;
$item->title = $comment->subject;
$item->link = $comment->link;
$item->elements = $comment->rss_elements;
$item->cid = $comment->cid;
return theme($this->theme_functions(), array(
'view' => $this->view,
'options' => $this->options,
'row' => $item,
));
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
views_object::$definition | public | property | Handler's definition. | |||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | |||
views_object::construct | public | function | Views handlers use a special construct function. | 4 | ||
views_object::destroy | public | function | Destructor. | 2 | ||
views_object::export_option | public | function | 1 | |||
views_object::export_options | public | function | ||||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | |||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 | |
views_object::set_default_options | public | function | Set default options. | |||
views_object::set_definition | public | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | public | function | Unpack a single option definition. | |||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | public | function | ||||
views_plugin::$display | public | property | The current used views display. | |||
views_plugin::$plugin_name | public | property | The plugin name of this plugin, for example table or full. | |||
views_plugin::$plugin_type | public | property | The plugin type of this plugin, for example style or query. | |||
views_plugin::$view | public | property | The top object of a view. | Overrides views_object::$view | 1 | |
views_plugin::additional_theme_functions | public | function | Provide a list of additional theme functions for the theme info page. | |||
views_plugin::plugin_title | public | function | Return the human readable name of the display. | |||
views_plugin::summary_title | public | function | Returns the summary of the settings in the display. | 8 | ||
views_plugin::theme_functions | public | function | Provide a full list of possible theme templates used by this style. | |||
views_plugin::validate | public | function | Validate that the plugin is correct and can be saved. | 3 | ||
views_plugin_row::init | public | function | 2 | |||
views_plugin_row::options_submit | 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. |
Overrides views_plugin::options_submit | 1 | |
views_plugin_row::options_validate | public | function | Validate the options form. | Overrides views_plugin::options_validate | ||
views_plugin_row::query | public | function | Add anything to the query that we might need to. | Overrides views_plugin::query | ||
views_plugin_row::uses_fields | public | function | ||||
views_plugin_row_comment_rss::$base_field | public | property | ||||
views_plugin_row_comment_rss::$base_table | public | property | ||||
views_plugin_row_comment_rss::options_form | public | function | Provide a form for setting options. | Overrides views_plugin_row::options_form | ||
views_plugin_row_comment_rss::options_form_summary_options | public | function | Return the main options, which are shown in the summary title. | |||
views_plugin_row_comment_rss::option_definition | public | function | Information about options for all kinds of purposes will be held here. | Overrides views_plugin_row::option_definition | ||
views_plugin_row_comment_rss::pre_render | public | function | Allow the style to do stuff before each row is rendered. | Overrides views_plugin_row::pre_render | ||
views_plugin_row_comment_rss::render | public | function | Render a row object. This usually passes through to a theme template of some form, but not always. |
Overrides views_plugin_row::render |