PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of comment.module

Functions

Functions that are not part of a class:

comment_help($path, $arg) X-Ref

Implementation of hook_help().

comment_theme() X-Ref

Implementation of hook_theme().

comment_menu() X-Ref

Implementation of hook_menu().

comment_node_type($op, $info) X-Ref

Implementation of hook_node_type().

comment_perm() X-Ref

Implementation of hook_perm().

comment_block($op = 'list', $delta = 0) X-Ref

Implementation of hook_block().

Generates a block with the most recent comments.

comment_get_recent($number = 10) X-Ref

Find a number of recent comments. This is done in two steps.
1. Find the n (specified by $number) nodes that have the most recent
comments. This is done by querying node_comment_statistics which has
an index on last_comment_timestamp, and is thus a fast query.
2. Loading the information from the comments table based on the nids found
in step 1.

param: $number
return:

comment_new_page_count($num_comments, $new_replies, $node) X-Ref

Calculate page number for first new comment.

param: $num_comments
param: $new_replies
param: $node
return:

theme_comment_block() X-Ref

Returns a formatted list of recent comments to be displayed in the comment block.

return:

comment_link($type, $node = NULL, $teaser = FALSE) X-Ref

Implementation of hook_link().

comment_form_alter(&$form, $form_state, $form_id) X-Ref

Implementation of hook_form_alter().

comment_nodeapi(&$node, $op, $arg = 0) X-Ref

Implementation of hook_nodeapi().

comment_user($type, $edit, &$user, $category = NULL) X-Ref

Implementation of hook_user().

comment_access($op, $comment) X-Ref

This is *not* a hook_access() implementation. This function is called
to determine whether the current user has access to a particular comment.

Authenticated users can edit their comments as long they have not been
replied to. This prevents people from changing or revising their
statements based on the replies to their posts.

param: $op
param: $comment
return:

comment_node_url() X-Ref

A simple helper function.

return:

comment_save($edit) X-Ref

Accepts a submission of new or changed comment content.

param: $edit
return:

comment_links($comment, $return = 1) X-Ref

Build command links for a comment (e.g.\ edit, reply, delete) with respect to the current user's access permissions.

param: $comment
param: $return
return:

comment_render($node, $cid = 0) X-Ref

Renders comment(s).

param: $node
param: $cid

comment_operations($action = NULL) X-Ref

Comment operations. We offer different update operations depending on
which comment administration page we're on.

param: $action
return:

_comment_load($cid) X-Ref

Load the entire comment by cid.

param: $cid
return:

comment_num_all($nid) X-Ref

Get comment count for a node.

param: $nid
return:

comment_num_replies($pid) X-Ref

Get replies count for a comment.

param: $pid
return:

comment_num_new($nid, $timestamp = 0) X-Ref

Get number of new comments for current user and specified node.

param: $nid
param: $timestamp

comment_validate($edit) X-Ref

Validate comment data.

param: $edit
return:

comment_form(&$form_state, $edit, $title = NULL) X-Ref

Generate the basic commenting form, for appending to a node or display on a separate page.

param: $title

comment_form_box($edit, $title = NULL) X-Ref

Theme the comment form box.

param: $edit
param: $title

comment_form_add_preview($form, &$form_state) X-Ref

Form builder; Generate and validate a comment preview form.

comment_form_validate($form, &$form_state) X-Ref

Validate comment form submissions.

_comment_form_submit(&$comment_values) X-Ref

Prepare a comment for submission.

param: $comment_values

comment_form_submit($form, &$form_state) X-Ref

Process comment form submissions; prepare the comment, store it, and set a redirection target.

theme_comment_view($comment, $node, $links = array() X-Ref

Themes a single comment and related items.

param: $comment
param: $node
param: $links
param: $visible

comment_controls(&$form_state, $mode = COMMENT_MODE_THREADED_EXPANDED, $order = COMMENT_ORDER_NEWEST_FIRST, $comments_per_page = 50) X-Ref

Build a comment control form.

param: $mode
param: $order
param: $comments_per_page

theme_comment_controls($form) X-Ref

Theme comment controls box where the user can change the default display mode and display order of comments.

param: $form

comment_controls_submit($form, &$form_state) X-Ref

Process comment_controls form submissions.

template_preprocess_comment(&$variables) X-Ref

Process variables for comment.tpl.php.

template_preprocess_comment_folded(&$variables) X-Ref

Process variables for comment-folded.tpl.php.

theme_comment_flat_collapsed($comment, $node) X-Ref

Theme comment flat collapsed view.

param: $comment
param: $node

theme_comment_flat_expanded($comment, $node) X-Ref

Theme comment flat expanded view.

param: $comment
param: $node

theme_comment_thread_collapsed($comment, $node) X-Ref

Theme comment thread collapsed view.

param: $comment
param: $node

theme_comment_thread_expanded($comment, $node) X-Ref

Theme comment thread expanded view.

param: $comment
param: $node

theme_comment_post_forbidden($node) X-Ref

Theme a "you can't post comments" notice.

param: $node

template_preprocess_comment_wrapper(&$variables) X-Ref

Process variables for comment-wrapper.tpl.php.

theme_comment_submitted($comment) X-Ref

Theme a "Submitted by ..." notice.

param: $comment

_comment_get_modes() X-Ref

Return an array of viewing modes for comment listings.

We can't use a global variable array because the locale system
is not initialized yet when the comment module is loaded.

_comment_get_orders() X-Ref

Return an array of viewing orders for comment listings.

We can't use a global variable array because the locale system
is not initialized yet when the comment module is loaded.

_comment_per_page() X-Ref

Return an array of "comments per page" settings from which the user
can choose.

_comment_get_display_setting($setting, $node) X-Ref

Return a current comment display setting

param: $setting
param: $node

_comment_update_node_statistics($nid) X-Ref

Updates the comment statistics for a given node. This should be called any
time a comment is added, deleted, or updated.

The following fields are contained in the node_comment_statistics table.
- last_comment_timestamp: the timestamp of the last comment for this node or the node create stamp if no comments exist for the node.
- last_comment_name: the name of the anonymous poster for the last comment
- last_comment_uid: the uid of the poster for the last comment for this node or the node authors uid if no comments exists for the node.
- comment_count: the total number of approved/published comments on this node.

comment_invoke_comment(&$comment, $op) X-Ref

Invoke a hook_comment() operation in all modules.

param: &$comment
param: $op
return:

int2vancode($i = 0) X-Ref

Generate vancode.

Consists of a leading character indicating length, followed by N digits
with a numerical value in base 36. Vancodes can be sorted as strings
without messing up numerical order.

It goes:
00, 01, 02, ..., 0y, 0z,
110, 111, ... , 1zy, 1zz,
2100, 2101, ..., 2zzy, 2zzz,
31000, 31001, ...

vancode2int($c = '00') X-Ref

Decode vancode back to an integer.

comment_hook_info() X-Ref

Implementation of hook_hook_info().

comment_action_info() X-Ref

Implementation of hook_action_info().

comment_publish_action($comment, $context = array() X-Ref

Action to publish a comment.

param: $comment
param: $context

comment_unpublish_action($comment, $context = array() X-Ref

Action to unpublish a comment.

param: $comment
param: $context

comment_unpublish_by_keyword_action($comment, $context) X-Ref

Action to unpublish a comment if it contains a certain string.

param: $comment
param: $context