Continued updates to comment stars

Author: ryancramerdesign

wire/modules/Fieldtype/FieldtypeComments/CommentArray.php

@@ -262,13 +262,14 @@ public function stars($allowPartial = true, $getCount = false) {
 	 */
 	public function renderStars($showCount = false, $options = array()) {
 		$defaults = array(
-			'stars' => null, 
-			'count' => null,
-			'blank' => true, // return blank if no ratings yet
+			'stars' => null, // optionally override the combined stars value (stars and count must both be specified)
+			'count' => null, // optionally override the combined count value (stars and count must both be specified)
+			'blank' => true, // return blank string if no ratings yet?
 			'partials' => true, // allow partial stars?
+			'schema' => '', // may be 'rdfa', 'microdata' or blank. Used only if showCount=true. 
 		);
 		$options = array_merge($defaults, $options);
-		if(!is_null($options['stars'])) {
+		if(!is_null($options['stars']) && !is_null($options['count'])) {
 			$stars = $options['stars'];
 			$count = (int) $options['count'];
 		} else {
@@ -277,7 +278,7 @@ public function renderStars($showCount = false, $options = array()) {
 		if(!$count && $options['blank']) return '';
 		$commentStars = new CommentStars();
 		$out = $commentStars->render($stars, false);
-		if($showCount) $out .= $commentStars->renderCount((int) $count, $stars);
+		if($showCount) $out .= $commentStars->renderCount((int) $count, $stars, $options['schema']);
 		return $out; 
 	}
 }

wire/modules/Fieldtype/FieldtypeComments/CommentList.php

@@ -62,6 +62,7 @@ class CommentList extends Wire implements CommentListInterface {
 		'upvoteFormat' => '↑{cnt}',
 		'downvoteFormat' => '↓{cnt}', 
 		'depth' => 0, 
+		'replyLabel' => 'Reply',
 		); 
 
 	/**
@@ -75,6 +76,7 @@ public function __construct(CommentArray $comments, $options = array()) {
 
 		$h3 = $this->_('h3'); // Headline tag
 		$this->options['headline'] = "<$h3>" . $this->_('Comments') . "</$h3>"; // Header text
+		$this->options['replyLabel'] = $this->_('Reply');
 
 		if(empty($options['commentHeader'])) {
 			if(empty($options['dateFormat'])) {
@@ -208,7 +210,7 @@ public function renderItem(Comment $comment, $depth = 0) {
 			$out .=
 				"\n\t\t<div class='CommentFooter'>" . 
 				"\n\t\t\t<p class='CommentAction'>" .
-				"\n\t\t\t\t<a class='CommentActionReply' data-comment-id='$comment->id' href='#Comment{$comment->id}'>" . $this->_('Reply') . "</a> " .
+				"\n\t\t\t\t<a class='CommentActionReply' data-comment-id='$comment->id' href='#Comment{$comment->id}'>" . $this->options['replyLabel'] . "</a> " .
 				($permalink ? "\n\t\t\t\t$permalink" : "") . 
 				"\n\t\t\t</p>" . 
 				"\n\t\t</div>";

wire/modules/Fieldtype/FieldtypeComments/CommentStars.php

@@ -23,9 +23,9 @@ class CommentStars extends WireData {
 		'wrapClass' => 'CommentStars', // required by JS and CSS
 		'wrapClassInput' => 'CommentStarsInput', // required by JS and CSS
 		'countClass' => 'CommentStarsCount', // class used for renderCount() method
-		'detailsLabel' => '%g/%d', // i.e. 4.5/5
-		'countLabelSingular' => '%s via %d rating', // i.e. 4/5 via 1 rating
-		'countLabelPlural' => '%s via %d ratings', // i.e. 4.5/5 via 10 ratings
+		'detailsLabel' => '%s/%s', // i.e. 4.5/5
+		'countLabelSingular' => '%1$s via %2$s rating', // i.e. 4/5 via 1 rating
+		'countLabelPlural' => '%1$s via %2$s ratings', // i.e. 4.5/5 via 10 ratings
 		'unratedLabel' => 'not yet rated',
 	);
 
@@ -39,8 +39,8 @@ public function __construct() {
 		foreach(self::$defaults as $key => $value) {
 			$this->set($key, $value);
 		}
-		$this->set('countLabelSingular', $this->_('%s (%d rating)'));
-		$this->set('countLabelPlural', $this->_('%s (%d ratings)'));
+		$this->set('countLabelSingular', $this->_('%1$s (%2$s rating)'));
+		$this->set('countLabelPlural', $this->_('%1$s (%2$s ratings)'));
 		$this->set('unratedLabel', $this->_('not yet rated'));
 	}
 
@@ -117,10 +117,11 @@ public function render($stars = 0, $allowInput = false) {
 	 * 
 	 * @param int $count
 	 * @param float|int $stars
+	 * @param string $schema May be "rdfa" or "microdata" or blank (default) to omit.
 	 * @return string
 	 * 
 	 */
-	public function renderCount($count, $stars = 0.0) {
+	public function renderCount($count, $stars = 0.0, $schema = '') {
 		$count = (int) $count;
 		if($stars > 0) {
 			if(is_int($stars)) {
@@ -129,12 +130,31 @@ public function renderCount($count, $stars = 0.0) {
 				if($stars > $this->numStars) $stars = 5.0;
 				$stars = round($stars, 1);
 			}
-			$details = sprintf($this->detailsLabel, $stars, $this->numStars);
-			$out = sprintf($this->_n($this->countLabelSingular, $this->countLabelPlural, $count), $details, $count);
+			if($schema == 'rdfa') {
+				$stars = "<span property='ratingValue'>$stars</span>";
+				$numStars = "<span property='bestRating'>$this->numStars</span>";
+				$countStr = "<span property='ratingCount'>$count</span>";
+				
+			} else if($schema == 'microdata') {
+				$stars = "<span itemprop='ratingValue'>$stars</span>";
+				$numStars = "<span itemprop='bestRating'>$this->numStars</span>";
+				$countStr = "<span itemprop='ratingCount'>$count</span>";
+			} else {
+				$numStars = $this->numStars;
+				$countStr = (string) $count;
+			}
+			$details = sprintf($this->detailsLabel, "$stars", "$numStars");
+			$label = $count === 1 ? $this->countLabelSingular : $this->countLabelPlural;
+			$out = sprintf($label, $details, $countStr);
 		} else {
 			$out = $this->unratedLabel;
 		}
-		return "<span class='$this->countClass'>$out</span>";
+		if($schema == 'rdfa') {
+			return "<span class='$this->countClass' property='aggregateRating' typeof='AggregateRating'>$out</span>";
+		} else if($schema == 'microdata') {
+			return "<span class='$this->countClass' itemprop='aggregateRating' itemscope itemtype='http://schema.org/AggregateRating'>$out</span>";
+		} else {
+			return "<span class='$this->countClass'>$out</span>";
+		}
 	}
-	
 }