r68125 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r68124‎ | r68125 | r68126 >
Date:15:14, 16 June 2010
Author:jeroendedauw
Status:deferred
Tags:
Comment:
Follow up to r68123 - documented functions
Modified paths:
  • /trunk/extensions/SemanticMediaWiki/includes/SMW_QueryProcessor.php (modified) (history)

Diff [purge]

Index: trunk/extensions/SemanticMediaWiki/includes/SMW_QueryProcessor.php
@@ -326,7 +326,11 @@
327327 }
328328
329329 /**
330 - * Determine format label from parameters.
 330+ * Determines the format from an array of parameters, and returns it.
 331+ *
 332+ * @param array $params
 333+ *
 334+ * @return string
331335 */
332336 static protected function getResultFormat( array $params ) {
333337 $format = 'auto';
@@ -345,6 +349,13 @@
346350 return $format;
347351 }
348352
 353+ /**
 354+ * Turns format aliases into main formats.
 355+ *
 356+ * @param string $format
 357+ *
 358+ * @return boolean Indicates if the passed format was an alias, and thus was changed.
 359+ */
349360 static protected function resolveFormatAliases( &$format ) {
350361 global $smwgResultAliases;
351362
@@ -365,6 +376,11 @@
366377 * Find suitable SMWResultPrinter for the given format. The context in which the query is to be
367378 * used determines some basic settings of the returned printer object. Possible contexts are
368379 * SMWQueryProcessor::SPECIAL_PAGE, SMWQueryProcessor::INLINE_QUERY, SMWQueryProcessor::CONCEPT_DESC.
 380+ *
 381+ * @param string $format
 382+ * @param $context
 383+ *
 384+ * @return SMWResultPrinter
369385 */
370386 static public function getResultPrinter( $format, $context = SMWQueryProcessor::SPECIAL_PAGE ) {
371387 global $smwgResultFormats;

Past revisions this follows-up on

RevisionCommit summaryAuthorDate
r68123Fixed issue with aliasing resolutionjeroendedauw14:12, 16 June 2010

Status & tagging log