<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][7395] trunk/bp-activity/bp-activity-akismet.php: Inline doc improvements for bp-activity-akismet.php</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7395">7395</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-08 20:57:41 +0000 (Tue, 08 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline doc improvements for bp-activity-akismet.php
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityakismetphp">trunk/bp-activity/bp-activity-akismet.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityakismetphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-akismet.php (7394 => 7395)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-akismet.php 2013-10-07 22:01:24 UTC (rev 7394)
+++ trunk/bp-activity/bp-activity-akismet.php 2013-10-08 20:57:41 UTC (rev 7395)
</span><span class="lines">@@ -1,6 +1,6 @@
</span><span class="cx"> <?php
</span><span class="cx"> /**
</span><del>- * Akismet support for BuddyPress' Activity Stream
</del><ins>+ * Akismet support for BuddyPress' Activity Stream.
</ins><span class="cx"> *
</span><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="lines">@@ -10,9 +10,14 @@
</span><span class="cx"> // Exit if accessed directly
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><ins>+/**
+ * Akismet support for the Activity component.
+ *
+ * @since BuddyPress (1.6)
+ */
</ins><span class="cx"> class BP_Akismet {
</span><span class="cx"> /**
</span><del>- * The activity last marked as spam
</del><ins>+ * The activity last marked as spam.
</ins><span class="cx"> *
</span><span class="cx"> * @access protected
</span><span class="cx"> * @var BP_Activity_Activity
</span><span class="lines">@@ -21,7 +26,7 @@
</span><span class="cx"> protected $last_activity = null;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Constructor
</del><ins>+ * Constructor.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -30,7 +35,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Hook Akismet into the activity stream
</del><ins>+ * Hook Akismet into the activity stream.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -64,10 +69,11 @@
</span><span class="cx"> * This function lifted with love from the Akismet WordPress plugin's
</span><span class="cx"> * akismet_comment_row_action() function. Thanks!
</span><span class="cx"> *
</span><del>- * @param array $actions The hover links
- * @param array $activity The activity for the current row being processed
- * @return array The hover links
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param array $actions The hover links.
+ * @param array $activity The activity for the current row being processed.
+ * @return array The hover links.
</ins><span class="cx"> */
</span><span class="cx"> function comment_row_action( $actions, $activity ) {
</span><span class="cx"> $akismet_result = bp_activity_get_meta( $activity['id'], '_bp_akismet_result' );
</span><span class="lines">@@ -110,11 +116,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Adds a nonce to the member profile status form, and to the reply form of each activity stream item.
- * This is used by Akismet to help detect spam activity.
</del><ins>+ * Generate nonces for activity forms.
</ins><span class="cx"> *
</span><ins>+ * These nonces appear in the member profile status form, as well as in
+ * the reply form of each activity item. The nonces are, in turn, used
+ * by Akismet to help detect spam activity.
+ *
+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see http://plugins.trac.wordpress.org/ticket/1232
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> public function add_activity_stream_nonce() {
</span><span class="cx"> $form_id = '_bp_as_nonce';
</span><span class="lines">@@ -130,15 +140,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check the member's latest (activity) update to see if it's the item that was (just) marked as spam.
</del><ins>+ * Clean up the bp_latest_update usermeta in case of spamming.
</ins><span class="cx"> *
</span><del>- * This can't be done in BP_Akismet::check_activity() due to BP-Default's AJAX implementation; see bp_dtheme_post_update().
</del><ins>+ * Run just after an update is posted, this method check to see whether
+ * the newly created update has been marked as spam by Akismet. If so,
+ * the cached update is cleared from the user's 'bp_latest_update'
+ * usermeta, ensuring that it won't appear in the member header and
+ * elsewhere in the theme.
</ins><span class="cx"> *
</span><del>- * @param string $content Activity update text
- * @param int $user_id User ID
- * @param int $activity_id Activity ID
</del><ins>+ * This can't be done in BP_Akismet::check_activity() due to the
+ * default AJAX implementation; see bp_dtheme_post_update().
+ *
+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see bp_dtheme_post_update()
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @param string $content Activity update text.
+ * @param int $user_id User ID.
+ * @param int $activity_id Activity ID.
</ins><span class="cx"> */
</span><span class="cx"> public function check_member_activity_update( $content, $user_id, $activity_id ) {
</span><span class="cx"> // By default, only handle activity updates and activity comments.
</span><span class="lines">@@ -211,22 +230,25 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get a list of filterable types of activity item that we want Akismet to automatically check for spam.
</del><ins>+ * Get a filterable list of activity types that Akismet should automatically check for spam.
</ins><span class="cx"> *
</span><del>- * @return array List of activity types
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
</ins><span class="cx"> * @static
</span><ins>+ *
+ * @return array List of activity types.
</ins><span class="cx"> */
</span><span class="cx"> public static function get_activity_types() {
</span><span class="cx"> return apply_filters( 'bp_akismet_get_activity_types', array( 'activity_comment', 'activity_update' ) );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Mark activity item as spam
</del><ins>+ * Mark activity item as spam.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @param BP_Activity_Activity $activity
</span><span class="cx"> * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet" (automatically spammed).
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> public function mark_as_spam( $activity, $source ) {
</span><span class="cx"> // Record this item so we can do some tidyup in BP_Akismet::check_member_activity_update()
</span><span class="lines">@@ -236,11 +258,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Mark activity item as ham
</del><ins>+ * Mark activity item as ham.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @param BP_Activity_Activity $activity
</span><span class="cx"> * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> public function mark_as_ham( $activity, $source ) {
</span><span class="cx"> // If the activity was, originally, automatically marked as spam by Akismet, run the @mentions filter as it would have been skipped.
</span><span class="lines">@@ -251,12 +274,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Build a data package for the Akismet service to inspect
</del><ins>+ * Build a data package for the Akismet service to inspect.
</ins><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity
</del><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see http://akismet.com/development/api/#comment-check
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> * @static
</span><ins>+ *
+ * @param BP_Activity_Activity $activity Activity item data.
</ins><span class="cx"> */
</span><span class="cx"> public static function build_akismet_data_package( $activity ) {
</span><span class="cx"> $userdata = get_userdata( $activity->user_id );
</span><span class="lines">@@ -290,13 +315,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if the activity item is spam or ham
</del><ins>+ * Check if the activity item is spam or ham.
</ins><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity The activity item to check
</del><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see http://akismet.com/development/api/
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> * @todo Spam counter?
</span><span class="cx"> * @todo Auto-delete old spam?
</span><ins>+ *
+ * @param BP_Activity_Activity $activity The activity item to check.
</ins><span class="cx"> */
</span><span class="cx"> public function check_activity( $activity ) {
</span><span class="cx"> // By default, only handle activity updates and activity comments.
</span><span class="lines">@@ -332,10 +359,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update activity meta after a manual spam change (user initiated)
</del><ins>+ * Update activity meta after a manual spam change (user-initiated).
</ins><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity The activity to check
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param BP_Activity_Activity $activity The activity to check.
</ins><span class="cx"> */
</span><span class="cx"> public function update_activity_spam_meta( $activity ) {
</span><span class="cx"> // By default, only handle activity updates and activity comments.
</span><span class="lines">@@ -348,10 +376,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update activity meta after a manual ham change (user initiated)
</del><ins>+ * Update activity meta after a manual ham change (user-initiated).
</ins><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity The activity to check
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param BP_Activity_Activity $activity The activity to check.
</ins><span class="cx"> */
</span><span class="cx"> public function update_activity_ham_meta( $activity ) {
</span><span class="cx"> // By default, only handle activity updates and activity comments.
</span><span class="lines">@@ -364,10 +393,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update activity meta after an automatic spam check (not user initiated)
</del><ins>+ * Update activity meta after an automatic spam check (not user-initiated).
</ins><span class="cx"> *
</span><del>- * @param BP_Activity_Activity $activity The activity to check
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param BP_Activity_Activity $activity The activity to check.
</ins><span class="cx"> */
</span><span class="cx"> public function update_activity_akismet_meta( $activity ) {
</span><span class="cx"> // Check we're dealing with what was last updated by Akismet
</span><span class="lines">@@ -399,16 +429,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Contact Akismet to check if this is spam or ham
</del><ins>+ * Contact Akismet to check if this is spam or ham.
</ins><span class="cx"> *
</span><del>- * Props to WordPress core Akismet plugin for alot of this
</del><ins>+ * Props to WordPress core Akismet plugin for alot of this.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @global string $akismet_api_host
</span><span class="cx"> * @global string $akismet_api_port
</span><del>- * @param array $activity_data Packet of information to submit to Akismet
- * @param string $check "check" or "submit"
- * @param string $spam "spam" or "ham"
- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @param array $activity_data Packet of information to submit to Akismet.
+ * @param string $check "check" or "submit".
+ * @param string $spam "spam" or "ham".
+ * @return array $activity_data Activity data, with Akismet data added.
</ins><span class="cx"> */
</span><span class="cx"> public function send_akismet_request( $activity_data, $check = 'check', $spam = 'spam' ) {
</span><span class="cx"> global $akismet_api_host, $akismet_api_port;
</span><span class="lines">@@ -477,10 +510,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filters user agent when sending to Akismet.
</del><ins>+ * Filters user agent when sending to Akismet to add BuddyPress info.
</ins><span class="cx"> *
</span><del>- * @param string $user_agent
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param string $user_agent User agent string, as generated by Akismet.
+ * @return string $user_agent Modified user agent string.
</ins><span class="cx"> */
</span><span class="cx"> public function buddypress_ua( $user_agent ) {
</span><span class="cx"> $user_agent = 'BuddyPress/' . bp_get_version() . ' | Akismet/'. constant( 'AKISMET_VERSION' );
</span><span class="lines">@@ -490,8 +525,9 @@
</span><span class="cx"> /**
</span><span class="cx"> * Adds a "History" meta box to the activity edit screen.
</span><span class="cx"> *
</span><del>- * @param string $screen_action The type of screen that has been requested
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param string $screen_action The type of screen that has been requested.
</ins><span class="cx"> */
</span><span class="cx"> function add_history_metabox( $screen_action ) {
</span><span class="cx"> // Only proceed if we're on the edit screen
</span><span class="lines">@@ -503,12 +539,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * History meta box for the Activity admin edit screen
</del><ins>+ * History meta box for the Activity admin edit screen.
</ins><span class="cx"> *
</span><del>- * @param object $item Activity item
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @see http://buddypress.trac.wordpress.org/ticket/3907
</ins><span class="cx"> * @todo Update activity meta to allow >1 record with the same key (iterate through $history).
</span><del>- * @see http://buddypress.trac.wordpress.org/ticket/3907
</del><ins>+ *
+ * @param object $item Activity item.
</ins><span class="cx"> */
</span><span class="cx"> function history_metabox( $item ) {
</span><span class="cx"> $history = BP_Akismet::get_activity_history( $item->id );
</span><span class="lines">@@ -522,12 +560,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Update an activity item's Akismet history
</del><ins>+ * Update an activity item's Akismet history.
</ins><span class="cx"> *
</span><del>- * @param int $activity_id Activity item ID
- * @param string $message Human-readable description of what's changed
- * @param string $event The type of check we were carrying out
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param int $activity_id Activity item ID.
+ * @param string $message Human-readable description of what's changed.
+ * @param string $event The type of check we were carrying out.
</ins><span class="cx"> */
</span><span class="cx"> public function update_activity_history( $activity_id = 0, $message = '', $event = '' ) {
</span><span class="cx"> $event = array(
</span><span class="lines">@@ -542,11 +581,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get an activity item's Akismet history
</del><ins>+ * Get an activity item's Akismet history.
</ins><span class="cx"> *
</span><del>- * @param int $activity_id Activity item ID
- * @return array The activity item's Akismet history
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param int $activity_id Activity item ID.
+ * @return array The activity item's Akismet history.
</ins><span class="cx"> */
</span><span class="cx"> public function get_activity_history( $activity_id = 0 ) {
</span><span class="cx"> $history = bp_activity_get_meta( $activity_id, '_bp_akismet_history' );
</span><span class="lines">@@ -561,11 +601,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Deletes old spam activity meta data, as _bp_akismet_submission meta can be large.
</del><ins>+ * Delete old spam activity meta data
</ins><span class="cx"> *
</span><del>- * @global object $bp BuddyPress global settings
- * @global wpdb $wpdb WordPress database object
</del><ins>+ * This is done as a clean-up mechanism, as _bp_akismet_submission meta can
+ * grow to be quite large.
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @global object $bp BuddyPress global settings.
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_akismet_delete_old_metadata() {
</span><span class="cx"> global $bp, $wpdb;
</span></span></pre>
</div>
</div>
</body>
</html>