<!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>[4269] sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php: Support Forums, User Badges: Allow author badges to display for topics as well.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/4269">4269</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/4269","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-19 19:09:38 +0000 (Wed, 19 Oct 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Support Forums, User Badges: Allow author badges to display for topics as well.
Also adds some missing docblocks and explicitly return false rather than null in a few places.
Fixes <a href="http://meta.trac.wordpress.org/ticket/2146">#2146</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbpuserbadgesincclasspluginphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporgbbpuserbadgesincclasspluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php 2016-10-19 18:15:36 UTC (rev 4268)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php 2016-10-19 19:09:38 UTC (rev 4269)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,15 +51,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function bbp_loaded() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Add class to div containing reply.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'bbp_get_topic_class', array( $this, 'bbp_get_topic_class' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bbp_get_reply_class', array( $this, 'bbp_get_reply_class' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add badge before reply author info.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'bbp_theme_before_reply_author_details', array( $this, 'add_user_badges' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'bbp_theme_before_topic_author_details', array( $this, 'show_topic_author_badge' ) );
+ add_action( 'bbp_theme_before_reply_author_details', array( $this, 'show_reply_author_badge' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function get_author_badge_info() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Return information about the resource item author if they merit a badge.
+ *
+ * Author badge is only applicable in support or reviews forums for a plugin
+ * or theme to which the author is listed as a committer or a contributor.
+ *
+ * @access protected
+ *
+ * @param string $item_type The type of thing whose author is being checked
+ * for badge info. One of 'topic' or 'reply'.
+ * @param int $item_id The ID of the item getting badge assigned.
+ * @return array|false Associative array with keys 'type', 'slug', and
+ * 'user_login' if author merits a badge, else false.
+ */
+ protected function get_author_badge_info( $item_type, $item_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! class_exists( '\WordPressdotorg\Forums\Plugin' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $badgeable_forums = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,20 +84,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> \WordPressdotorg\Forums\Plugin::THEMES_FORUM_ID,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $forum_id = bbp_get_reply_forum_id();
- $topic_id = bbp_get_reply_topic_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'topic' === $item_type ) {
+ $forum_id = bbp_get_topic_forum_id();
+ $topic_id = $item_id;
+ $user_id = bbp_get_topic_author_id();
+ } else {
+ $forum_id = bbp_get_reply_forum_id();
+ $topic_id = bbp_get_reply_topic_id();
+ $user_id = bbp_get_reply_author_id();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $forum_id, $badgeable_forums ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $slugs = $types = array();
-
- $user_id = bbp_get_reply_author_id();
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $user_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $slugs = $types = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $user_login = get_user_by( 'id', $user_id )->user_login;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check if the thread is associated with a plugin.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,7 +121,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> // Else not a type of concern.
</span><span class="cx" style="display: block; padding: 0 10px"> else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $types as $type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,7 +132,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $slugs ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -120,14 +142,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Amends the provided classes for a given topic with badge-related classes.
+ *
+ * @param array $classes Array of existing classes.
+ * @param int $topic_id The ID of the topic.
+ * @return array
+ */
+ public function bbp_get_topic_class( $classes, $topic_id ) {
+ return $this->get_badge_class( $classes, 'topic', $topic_id );
+ }
+
+ /**
+ * Amends the provided classes for a given reply with badge-related classes.
+ *
+ * @param array $classes Array of existing classes.
+ * @param int $reply_id The ID of the reply.
+ * @return array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function bbp_get_reply_class( $classes, $reply_id ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $this->get_badge_class( $classes, 'reply', $reply_id );
+ }
+
+ /**
+ * Amends the provided classes with badge-related classes.
+ *
+ * Possible badge classes:
+ * - by-moderator (Note: will always be added if author is a moderator)
+ * - by-plugin-author
+ * - by-plugin-contributor
+ * - by-theme-author
+ * - by-theme-contributor
+ *
+ * @access protected
+ *
+ * @param array $classes Array of existing classes.
+ * @param string $item_type The type of thing getting badge assigned. One of 'topic' or 'reply'.
+ * @param int $item_id The ID of the item getting badge assigned.
+ * @return array
+ */
+ protected function get_badge_class( $classes, $item_type, $item_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Class related to moderators.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->is_user_moderator() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $classes[] = 'by-moderator';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Class related to plugin and theme authors/contributors.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $info = $this->get_author_badge_info() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $info = $this->get_author_badge_info( $item_type, $item_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->is_user_author( $info['user_login'], $info['type'], $info['slug'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $contrib_type = 'author';
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $this->is_user_contributor( $info['user_login'], $info['type'], $info['slug'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,12 +206,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display author badge if reply author is in support or reviews forum for
- * the plugin/theme they contribute to.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Display badge for topic author if they merit a badge.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function add_user_badges() {
- $output = $this->get_author_badge();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function show_topic_author_badge() {
+ $this->show_user_badge( 'topic', bbp_get_topic_id() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Display badge for reply author if they merit a badge.
+ */
+ public function show_reply_author_badge() {
+ $this->show_user_badge( 'reply', bbp_get_reply_id() );
+ }
+
+ /**
+ * Display badge if the author merits a badge.
+ *
+ * @access protected
+ *
+ * @param string $item_type The type of thing getting badge assigned. One of 'topic' or 'reply'.
+ * @param int $item_id The ID of the item getting badge assigned.
+ */
+ protected function show_user_badge( $item_type, $item_id ) {
+ $output = $this->get_author_badge( $item_type, $item_id );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Don't assign moderator badge if already assigning author badge.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $output ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $output = $this->get_moderator_badge();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,6 +240,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Returns the HTML formatted badge.
+ *
+ * @param $type string The type of badge.
+ * @param $label string The label for the badge.
+ * @param $help string Optional. Help/descriptive text for the badge.
+ * @return string
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> protected function format_badge( $type, $label, $help = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $output = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -177,9 +264,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $output;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function get_author_badge() {
- if ( ! $info = $this->get_author_badge_info() ) {
- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Get badge if the author merits a badge for being a plugin/theme author or
+ * contributor.
+ *
+ * @access protected
+ *
+ * @param string $item_type The type of thing getting badge assigned. One of
+ * 'topic' or 'reply'.
+ * @param int $item_id The ID of the item getting badge assigned.
+ * @return array|false Associative array with keys 'type', 'slug', and
+ * 'user_login' if author merits a badge, else null.
+ */
+ protected function get_author_badge( $item_type, $item_id ) {
+ if ( ! $info = $this->get_author_badge_info( $item_type, $item_id ) ) {
+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $label = $help = null;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -207,6 +306,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $label ? array( 'type' => $info['type'], 'label' => $label, 'help' => $help ) : false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Get badge if the author merits a badge for being a moderator.
+ *
+ * @access protected
+ *
+ * @return array|false Associative array with keys 'type', 'slug', and
+ * 'user_login' if author merits a badge, else false.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> protected function get_moderator_badge() {
</span><span class="cx" style="display: block; padding: 0 10px"> $label = $help = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>