<!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>[3961] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-ratings-compat.php: Support Forums: Add ratings compat class.</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/3961">3961</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/3961","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jmdodd</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-05 18:35:12 +0000 (Mon, 05 Sep 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: Add ratings compat class.
Adds star rating display to plugin/theme reviews view and topic view.
Adds reviews header with detailed stats.
Adds filterable star ratings.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassratingscompatphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-ratings-compat.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassratingscompatphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-ratings-compat.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/support-forums/inc/class-ratings-compat.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-ratings-compat.php 2016-09-05 18:35:12 UTC (rev 3961)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,186 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordPressdotorg\Forums;
+
+class Ratings_Compat {
+
+ var $compat = null;
+ var $slug = null;
+ var $object = null;
+
+ var $filter = false;
+
+ public function __construct( $compat, $slug, $object, $rating = 0 ) {
+ if ( ! class_exists( 'WPORG_Ratings' ) ) {
+ return;
+ }
+
+ if ( empty( $compat ) || empty( $slug ) || empty( $object ) ) {
+ return;
+ }
+
+ $this->compat = $compat;
+ $this->slug = $slug;
+ $this->object = $object;
+ $this->rating = $rating;
+
+ $this->reviews_count = \WPORG_Ratings::get_rating_count( $this->compat, $this->slug, $this->rating );
+ $this->ratings_counts = \WPORG_Ratings::get_rating_counts( $this->compat, $this->slug );
+ $this->avg_rating = \WPORG_Ratings::get_avg_rating( $this->compat, $this->slug );
+
+ // Set up a filter on star rating number.
+ if ( isset( $_GET['filter'] ) ) {
+ $filter = absint( $_GET['filter'] );
+ if ( $filter > 5 ) {
+ $filter = 5;
+ }
+ $this->filter = $filter;
+ add_filter( 'posts_clauses', array( $this, 'add_filter_to_posts_clauses' ) );
+ add_action( 'pre_get_posts', array( $this, 'no_found_rows' ) );
+ add_filter( 'bbp_topic_pagination', array( $this, 'add_filter_topic_pagination' ) );
+ }
+
+ // Set up the single topic.
+ add_action( 'bbp_template_before_lead_topic', array( $this, 'add_topic_stars' ) );
+
+ // Set up ratings view.
+ add_action( 'wporg_compat_before_single_view', array( $this, 'do_view_header' ) );
+ add_filter( 'bbp_get_topic_title', array( $this, 'get_topic_title' ), 10, 2 );
+ }
+
+ /**
+ * Whenever possible, unset SQL_CALC_FOUND_ROWS using this filter.
+ */
+ public function no_found_rows( $q ) {
+ $q->set( 'no_found_rows', true );
+ }
+
+ /**
+ * Allow ratings view to be filtered by star rating.
+ */
+ public function add_filter_to_posts_clauses( $clauses ) {
+ global $wpdb;
+
+ $clauses['join'] .= " JOIN ratings ON ( $wpdb->posts.ID = ratings.post_id )";
+ $clauses['where'] .= $wpdb->prepare( " AND ratings.rating = %d", $this->filter );
+
+ return $clauses;
+ }
+
+ public function add_filter_topic_pagination( $r ) {
+ $count = $this->ratings_counts[ $this->filter ];
+ $r['total'] = $count / bbp_get_topics_per_page();
+ return $r;
+ }
+
+ /**
+ * Display star ratings for an individual review topic.
+ */
+ public function add_topic_stars() {
+ if ( bbp_is_single_topic() && Plugin::REVIEWS_FORUM_ID == bbp_get_topic_forum_id() ) {
+ $user_id = bbp_get_topic_author_id();
+ $rating = \WPORG_Ratings::get_user_rating( $this->compat, $this->slug, $user_id );
+ if ( $rating > 0 ) {
+ echo \WPORG_Ratings::get_dashicons_stars( $rating );
+ }
+ }
+ }
+
+ /**
+ * Display star ratings next to topic titles in the review forum view.
+ *
+ * @param string $title The topic title
+ * @param int $topic_id The topic id
+ */
+ public function get_topic_title( $title, $topic_id ) {
+ if ( bbp_is_single_view() && 'reviews' == bbp_get_view_id() ) {
+ $user_id = bbp_get_topic_author_id( $topic_id );
+ $rating = \WPORG_Ratings::get_user_rating( $this->compat, $this->slug, $user_id );
+ if ( $rating > 0 ) {
+ $title .= ' ' . \WPORG_Ratings::get_dashicons_stars( $rating );
+ }
+ }
+ return $title;
+ }
+
+ public function do_view_header() {
+ if ( ! bbp_is_single_view() || 'reviews' != bbp_get_view_id() ) {
+ return;
+ }
+ ?>
+<link itemprop="applicationCategory" href="http://schema.org/OtherApplication" />
+<span itemprop="offers" itemscope itemtype="http://schema.org/Offer">
+ <meta itemprop="price" content="0.00" />
+ <meta itemprop="priceCurrency" content="USD" />
+ <span itemprop="seller" itemscope itemtype="http://schema.org/Organization">
+ <span itemprop="name" content="WordPress.org"></span>
+ </span>
+</span>
+
+<div class="review-ratings" itemprop="aggregateRating" itemscope itemtype="http://schema.org/AggregateRating">
+ <div class="col-3">
+ <div class="reviews-about" style="display:none;" itemprop="itemReviewed"><?php echo esc_html( $this->object->post_title ); ?></div>
+ <div class="reviews-total-count"><?php printf( _n( '<span itemprop="reviewCount">%d</span> review', '<span itemprop="reviewCount">%d</span> reviews', $this->reviews_count ), $this->reviews_count ); ?></div>
+ <?php
+ foreach ( array( 5, 4, 3, 2, 1 ) as $rating ) {
+ $ratings_count = isset( $this->ratings_counts[ $rating ] ) ? $this->ratings_counts[ $rating ] : 0;
+ $ratings_count_total = isset( $this->ratings_counts ) ? array_sum( $this->ratings_counts) : 0;
+ $stars_title = sprintf( _n( 'Click to see reviews that provided a rating of %d star', 'Click to see reviews that provided a rating of %d stars', $rating, 'wporg-forums' ), $rating );
+ $stars_text = sprintf( __( '%d stars', 'wporg-forums' ), $rating );
+ $width = 0;
+ if ( $ratings_count && $ratings_count_total ) {
+ $width = 92 * ( $ratings_count / $ratings_count_total );
+ }
+ ?>
+ <div class="counter-container">
+ <a href="<?php echo esc_url( sprintf( 'https://wordpress.org/support/%s/%s/reviews/?filter=%s', $this->compat, $this->slug, $rating ) ); ?>"
+ title="<?php echo esc_attr( $stars_title ); ?>">
+ <span class="counter-label" style="float:left;margin-right:5px;"><?php echo esc_html( $stars_text ); ?></span>
+ <span class="counter-back" style="height:17px;width:92px;background-color:#ececec;float:left;">
+ <span class="counter-bar" style="width:<?php echo esc_attr( $width ); ?>px;height:17px;background-color:#ffc733;float:left;"></span>
+ </span>
+ </a>
+ <span class="counter-count" style="margin-left:5px;"><?php echo esc_html( $ratings_count ); ?></span>
+ </div>
+ <?php
+ }
+ ?>
+ </div>
+ <div class="col-3">
+ <div style="font-weight:bold;"><?php _e( 'Average Rating', 'wporg-forums' ); ?></div>
+ <?php echo \WPORG_Ratings::get_dashicons_stars( $this->avg_rating ); ?><?php echo sprintf( __( '%s out of <span itemprop="bestRating">5</span> stars', 'wporg-forums' ), round( isset( $this->avg_rating ) ? $this->avg_rating : 0, 1 ) ); ?>
+ <div class="reviews-submit-link">
+ <?php
+ if ( is_user_logged_in() ) {
+ echo '<a href="#postform" class="btn">';
+ _e( 'Add your own review', 'wporg-forums' );
+ echo '</a>';
+ } else {
+ echo '<span class="reviews-need-login">';
+ printf(
+ __( 'You must %s to submit a review.You can also log in or register using the form near the top of this page.' ),
+ sprintf( '<a href="https://login.wordpress.org/">%s</a>', esc_html_x( 'log in', 'verb: You must log in to submit a review.', 'wporg-forums' ) ) );
+ echo '</span>';
+ }
+ ?>
+ </div>
+ </div>
+ <div class="col-1">
+ </div>
+ <?php
+ // If current listing is filtered by rating, display message indicating this,
+ // along with an explicit link to return them to the unfiltered view.
+ $filter = isset( $_GET['filter'] ) ? absint( $_GET['filter'] ) : 0;
+ if ( $filter > 0 && $filter < 6 ) {
+ echo '<div class="col-10 reviews-filtered-msg" style="font-style:italic;margin-top:24px;">';
+ printf(
+ _n( 'You are currently viewing the reviews that provided a rating of <strong>%d star</strong>. <a href="%s">Click here</a> to see all reviews.',
+ 'You are currently viewing the reviews that provided a rating of <strong>%d stars</strong>. <a href="%s">Click here</a> to see all reviews.',
+ 'wporg-forums' ), $filter, esc_url ( sprintf( '//wordpress.org/support/%s/%s/reviews/', $this->compat, $this->slug ) ) );
+ echo "</div>\n";
+ }
+ ?>
+</div>
+ <?php
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-ratings-compat.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>