https://www.mediawiki.org/wiki/Special:Code/MediaWiki/108277
Revision: 108277
Author: rsterbin
Date: 2012-01-06 20:11:50 +0000 (Fri, 06 Jan 2012)
Log Message:
-----------
Doc block comments for Special page; fixed a missing @return in one of the js
doc blocks
Modified Paths:
--------------
trunk/extensions/ArticleFeedbackv5/SpecialArticleFeedbackv5.php
trunk/extensions/ArticleFeedbackv5/modules/jquery.articleFeedbackv5/jquery.articleFeedbackv5.special.js
Modified: trunk/extensions/ArticleFeedbackv5/SpecialArticleFeedbackv5.php
===================================================================
--- trunk/extensions/ArticleFeedbackv5/SpecialArticleFeedbackv5.php
2012-01-06 20:06:49 UTC (rev 108276)
+++ trunk/extensions/ArticleFeedbackv5/SpecialArticleFeedbackv5.php
2012-01-06 20:11:50 UTC (rev 108277)
@@ -1,9 +1,33 @@
<?php
+/**
+ * SpecialArticleFeedbackv5 class
+ *
+ * @package ArticleFeedback
+ * @subpackage Special
+ * @author Greg Chiasson <[email protected]>
+ * @version $Id$
+ */
+
+/**
+ * This is the Special page the shows the feedback dashboard
+ *
+ * @package ArticleFeedback
+ * @subpackage Special
+ */
class SpecialArticleFeedbackv5 extends SpecialPage {
+
+ /**
+ * Constructor
+ */
public function __construct() {
parent::__construct( 'ArticleFeedbackv5' );
}
+ /**
+ * Executes the special page
+ *
+ * @param $param string the parameter passed in the url
+ */
public function execute( $param ) {
$out = $this->getOutput();
$title = Title::newFromText( $param );
@@ -103,18 +127,23 @@
* Takes an associative array of label to value and converts the message
* names into localized strings
*
- * @param array $options
- * @return array
+ * @param $options array the options, indexed by label
+ * @return array the options, indexed by localized and escaped text
*/
private function selectMsg( array $options ) {
$newOpts = array();
foreach ( $options as $label => $value ) {
$newOpts[$this->msg( $label )->escaped()] = $value;
}
-
return $newOpts;
}
+ /**
+ * Grabs the overall rating for a page
+ *
+ * @param $pageId int the page id
+ * @return array the overall rating, as array (found => %, rating =>
avg)
+ */
private function fetchOverallRating( $pageId ) {
$rv = array();
$dbr = wfGetDB( DB_SLAVE );
@@ -144,4 +173,6 @@
return $rv;
}
+
}
+
Modified:
trunk/extensions/ArticleFeedbackv5/modules/jquery.articleFeedbackv5/jquery.articleFeedbackv5.special.js
===================================================================
---
trunk/extensions/ArticleFeedbackv5/modules/jquery.articleFeedbackv5/jquery.articleFeedbackv5.special.js
2012-01-06 20:06:49 UTC (rev 108276)
+++
trunk/extensions/ArticleFeedbackv5/modules/jquery.articleFeedbackv5/jquery.articleFeedbackv5.special.js
2012-01-06 20:11:50 UTC (rev 108277)
@@ -179,6 +179,8 @@
* When a next-page load is requested, it appends the new responses; on
a
* sort or filter change, the existing responses are removed from the
view
* and replaced.
+ *
+ * @param resetContents bool whether to remove the existing responses
*/
$.articleFeedbackv5special.loadFeedback = function ( resetContents ) {
$.ajax( {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
