http://www.mediawiki.org/wiki/Special:Code/MediaWiki/99110
Revision: 99110
Author: reedy
Date: 2011-10-06 14:53:38 +0000 (Thu, 06 Oct 2011)
Log Message:
-----------
Documentation
Return all paths
Documentation
Explicit member variable definitions
Modified Paths:
--------------
trunk/extensions/Translate/FFS.php
trunk/extensions/Translate/Groups.php
trunk/extensions/Translate/MessageGroups.php
trunk/extensions/Translate/TranslateHooks.php
trunk/extensions/Translate/TranslateUtils.php
trunk/extensions/Translate/ffs/DTD.php
trunk/extensions/Translate/ffs/Gettext.php
trunk/extensions/Translate/ffs/Simple.php
trunk/extensions/Translate/ffs/Voctrain.php
trunk/extensions/Translate/ffs/Wiki.php
trunk/extensions/Translate/ffs/WikiExtension.php
trunk/extensions/Translate/ffs/Xliff.php
trunk/extensions/Translate/specials/SpecialManageGroups.php
trunk/extensions/Translate/specials/SpecialMessageGroupStats.php
trunk/extensions/Translate/tag/DeleteJob.php
trunk/extensions/Translate/tag/MoveJob.php
trunk/extensions/Translate/tag/PageTranslationHooks.php
trunk/extensions/Translate/tag/SpecialPageTranslation.php
trunk/extensions/Translate/tag/SpecialPageTranslationDeletePage.php
trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php
trunk/extensions/Translate/tag/TranslatablePage.php
trunk/extensions/Translate/utils/JsSelectToInput.php
trunk/extensions/Translate/utils/MessageTable.php
trunk/extensions/Translate/utils/MessageWebImporter.php
trunk/extensions/Translate/utils/RevTag.php
trunk/extensions/Translate/utils/TranslateYaml.php
trunk/extensions/Translate/utils/TranslationHelpers.php
Modified: trunk/extensions/Translate/FFS.php
===================================================================
--- trunk/extensions/Translate/FFS.php 2011-10-06 14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/FFS.php 2011-10-06 14:53:38 UTC (rev 99110)
@@ -470,6 +470,7 @@
if ( $output ) {
return $header . $output;
}
+ return '';
}
/**
Modified: trunk/extensions/Translate/Groups.php
===================================================================
--- trunk/extensions/Translate/Groups.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/Groups.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -395,6 +395,9 @@
* custom type of message groups.
*/
class FileBasedMessageGroup extends MessageGroupBase {
+
+ protected $reverseCodeMap;
+
/**
* Constructs a FileBasedMessageGroup from any normal message group.
* Useful for doing special Gettext exports from any group.
@@ -469,6 +472,10 @@
return str_replace( array_keys( $variables ), array_values(
$variables ), $pattern );
}
+ /**
+ * @param $code
+ * @return string
+ */
public function mapCode( $code ) {
if ( !isset( $this->conf['FILES']['codeMap'] ) ) {
return $code;
Modified: trunk/extensions/Translate/MessageGroups.php
===================================================================
--- trunk/extensions/Translate/MessageGroups.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/MessageGroups.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -18,14 +18,30 @@
* Human-readable name of this group
*/
protected $label = 'none';
+
+ /**
+ * @return string
+ */
public function getLabel() { return $this->label; }
+
+ /**
+ * @param $value string
+ */
public function setLabel( $value ) { $this->label = $value; }
/**
* Group-wide unique id of this group. Used also for sorting.
*/
protected $id = 'none';
+
+ /**
+ * @return string
+ */
public function getId() { return $this->id; }
+
+ /**
+ * @param $value string
+ */
public function setId( $value ) { $this->id = $value; }
/**
@@ -33,14 +49,30 @@
* needed.
*/
protected $optional = array();
+
+ /**
+ * @return array
+ */
public function getOptional() { return $this->optional; }
+
+ /**
+ * @param $value array
+ */
public function setOptional( $value ) { $this->optional = $value; }
/**
* List of messages that are always hidden and cannot be translated.
*/
protected $ignored = array();
+
+ /**
+ * @return array
+ */
public function getIgnored() { return $this->ignored; }
+
+ /**
+ * @param $value array
+ */
public function setIgnored( $value ) { $this->ignored = $value; }
/**
@@ -1014,15 +1046,13 @@
$creater = $wgTranslateAC[$id];
if ( is_array( $creater ) ) {
return call_user_func( $creater, $id );
- } else {
- return new $creater;
}
+ return new $creater;
} elseif ( isset( $wgTranslateCC[$id] ) ) {
if ( is_callable( $wgTranslateCC[$id] ) ) {
return call_user_func( $wgTranslateCC[$id], $id
);
- } else {
- return $wgTranslateCC[$id];
}
+ return $wgTranslateCC[$id];
}
}
Modified: trunk/extensions/Translate/TranslateHooks.php
===================================================================
--- trunk/extensions/Translate/TranslateHooks.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/TranslateHooks.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -12,7 +12,12 @@
* Some hooks for Translate extension.
*/
class TranslateHooks {
- /// Hook: CanonicalNamespaces
+
+ /**
+ * Hook: CanonicalNamespaces
+ * @param $list array
+ * @return bool
+ */
public static function setupNamespaces( &$list ) {
global $wgPageTranslationNamespace;
if ( !defined( 'NS_TRANSLATIONS' ) ) {
Modified: trunk/extensions/Translate/TranslateUtils.php
===================================================================
--- trunk/extensions/Translate/TranslateUtils.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/TranslateUtils.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -224,7 +224,7 @@
* Returns the primary group message belongs to.
* @param $namespace \int
* @param $key \string
- * @return \types{\string,\null} Group id or null.
+ * @return string|null Group id or null.
*/
public static function messageKeyToGroup( $namespace, $key ) {
$groups = self::messageKeyToGroups( $namespace, $key );
Modified: trunk/extensions/Translate/ffs/DTD.php
===================================================================
--- trunk/extensions/Translate/ffs/DTD.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/DTD.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -16,6 +16,11 @@
* @ingroup FFS
*/
class DtdFFS extends SimpleFFS {
+
+ /**
+ * @param $data string
+ * @return array
+ */
public function readFromVariable( $data ) {
preg_match_all( ',AUTHOR: ([^\n]+)\n,', $data, $matches );
$authors = array();
Modified: trunk/extensions/Translate/ffs/Gettext.php
===================================================================
--- trunk/extensions/Translate/ffs/Gettext.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/Gettext.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -21,6 +21,9 @@
class GettextFFS extends SimpleFFS {
protected $offlineMode = false;
+ /**
+ * @param $value bool
+ */
public function setOfflineMode( $value ) {
$this->offlineMode = $value;
}
Modified: trunk/extensions/Translate/ffs/Simple.php
===================================================================
--- trunk/extensions/Translate/ffs/Simple.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/Simple.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -28,6 +28,9 @@
protected $authors = null;
protected $staticHeader = '';
+ /**
+ * @return array
+ */
public function parseAuthors() {
if ( $this->authors === null ) {
$this->parseHeader();
@@ -35,6 +38,9 @@
return $this->authors;
}
+ /**
+ * @return string
+ */
public function parseStaticHeader() {
if ( $this->staticHeader === '' ) {
$this->parseHeader();
@@ -81,6 +87,11 @@
}
protected $messagePattern = '/([^\0]+)\0([^\0]+)\0\n/U';
+
+ /**
+ * @param $mangler StringMangler
+ * @return array
+ */
public function parseMessages( StringMangler $mangler ) {
$data = file_get_contents( $this->filename );
Modified: trunk/extensions/Translate/ffs/Voctrain.php
===================================================================
--- trunk/extensions/Translate/ffs/Voctrain.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/Voctrain.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -13,6 +13,9 @@
*/
class VoctrainMessageGroup extends ExtensionMessageGroup {
+ /**
+ * @return VoctrainMessageChecker
+ */
public function getChecker() {
$checker = new VoctrainMessageChecker( $this );
$checker->setChecks( array(
Modified: trunk/extensions/Translate/ffs/Wiki.php
===================================================================
--- trunk/extensions/Translate/ffs/Wiki.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/Wiki.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -31,6 +31,9 @@
return $m[1];
}
+ /**
+ * @return string
+ */
public function parseStaticHeader() {
if ( $this->filename === false ) {
return '';
Modified: trunk/extensions/Translate/ffs/WikiExtension.php
===================================================================
--- trunk/extensions/Translate/ffs/WikiExtension.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/ffs/WikiExtension.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -13,6 +13,12 @@
* @todo Needs documentation and conversion to new style message group.
*/
class WikiExtensionFormatReader extends WikiFormatReader {
+
+ /**
+ * @param $var
+ * @return array
+ * @throws MWException
+ */
public function parseSections( $var ) {
if ( $this->filename === false ) {
return array( '', array() );
Modified: trunk/extensions/Translate/ffs/Xliff.php
===================================================================
--- trunk/extensions/Translate/ffs/Xliff.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/ffs/Xliff.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -16,7 +16,12 @@
* @deprecated Old style writer.
*/
class XliffFormatWriter extends SimpleFormatWriter {
- // Re-implemented
+
+ /**
+ * Re-implemented
+ * @param $target
+ * @param $collection MessageCollection
+ */
protected function exportLanguage( $target, MessageCollection
$collection ) {
$code = $collection->code;
$w = new XMLWriter();
Modified: trunk/extensions/Translate/specials/SpecialManageGroups.php
===================================================================
--- trunk/extensions/Translate/specials/SpecialManageGroups.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/specials/SpecialManageGroups.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -33,6 +33,8 @@
*/
protected $out;
+ protected $time;
+
/// Maximum allowed processing time in seconds.
protected $processingTime = 30;
Modified: trunk/extensions/Translate/specials/SpecialMessageGroupStats.php
===================================================================
--- trunk/extensions/Translate/specials/SpecialMessageGroupStats.php
2011-10-06 14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/specials/SpecialMessageGroupStats.php
2011-10-06 14:53:38 UTC (rev 99110)
@@ -22,6 +22,10 @@
/// Overwritten from SpecialLanguageStats
protected $noEmpty = true;
+ protected $names;
+
+ protected $translate;
+
public function __construct() {
SpecialPage::__construct( 'MessageGroupStats' );
}
Modified: trunk/extensions/Translate/tag/DeleteJob.php
===================================================================
--- trunk/extensions/Translate/tag/DeleteJob.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/tag/DeleteJob.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -15,6 +15,15 @@
* @todo Get rid of direct reference to $wgMemc.
*/
class DeleteJob extends Job {
+
+ /**
+ * @static
+ * @param $target Title
+ * @param $base
+ * @param $full
+ * @param $performer
+ * @return DeleteJob
+ */
public static function newJob( Title $target, $base, $full, /*User*/
$performer ) {
global $wgTranslateFuzzyBotName;
@@ -103,6 +112,9 @@
return $this->params['full'];
}
+ /**
+ * @param $performer User|string
+ */
public function setPerformer( $performer ) {
if ( is_object( $performer ) ) {
$this->params['performer'] = $performer->getName();
@@ -115,6 +127,9 @@
return $this->params['performer'];
}
+ /**
+ * @param $user User|string
+ */
public function setUser( $user ) {
if ( is_object( $user ) ) {
$this->params['user'] = $user->getName();
Modified: trunk/extensions/Translate/tag/MoveJob.php
===================================================================
--- trunk/extensions/Translate/tag/MoveJob.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/tag/MoveJob.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -15,6 +15,14 @@
* @todo Get rid of direct reference to $wgMemc.
*/
class MoveJob extends Job {
+
+ /**
+ * @param $source Title
+ * @param $target Title
+ * @param $base
+ * @param $performer
+ * @return MoveJob
+ */
public static function newJob( Title $source, Title $target, $base,
/*User*/ $performer ) {
global $wgTranslateFuzzyBotName;
Modified: trunk/extensions/Translate/tag/PageTranslationHooks.php
===================================================================
--- trunk/extensions/Translate/tag/PageTranslationHooks.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/tag/PageTranslationHooks.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -133,7 +133,7 @@
$group = MessageGroups::getGroup( $groupKey );
if ( !$group instanceof WikiPageMessageGroup ) {
SpecialPageTranslation::superDebug( __METHOD__, 'not
wp-group', $title, $user, $groupKey );
- return;
+ return true;
}
// Finally we know the title and can construct a Translatable
page
@@ -538,6 +538,15 @@
return true;
}
+ /**
+ * @static
+ * @param $type
+ * @param $action
+ * @param $title Title
+ * @param $forUI
+ * @param $params
+ * @return String
+ */
public static function formatLogEntry( $type, $action, $title, $forUI,
$params ) {
global $wgLang, $wgContLang;
@@ -569,6 +578,7 @@
} elseif ( $action === 'deletelok' ) {
return wfMsgExt( 'pt-log-delete-lang-ok', $opts,
$title->getPrefixedText(), $user );
}
+ return '';
}
public static function replaceMovePage( &$list ) {
Modified: trunk/extensions/Translate/tag/SpecialPageTranslation.php
===================================================================
--- trunk/extensions/Translate/tag/SpecialPageTranslation.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/tag/SpecialPageTranslation.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -255,7 +255,8 @@
* @param $title Title
* @param $rev
* @param $latest
- * @param string $old
+ * @param $old string
+ * @return string
*/
protected function actionLinks( $title, $rev, $latest, $old = 'old' ) {
$actions = array();
Modified: trunk/extensions/Translate/tag/SpecialPageTranslationDeletePage.php
===================================================================
--- trunk/extensions/Translate/tag/SpecialPageTranslationDeletePage.php
2011-10-06 14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/tag/SpecialPageTranslationDeletePage.php
2011-10-06 14:53:38 UTC (rev 99110)
@@ -37,9 +37,14 @@
* @var TranslatablePage
*/
protected $page;
+
/// Contains the language code if we are working with translation page
protected $code;
+ protected $sectionPages;
+
+ protected $translationPages;
+
/**
* User instance.
*
Modified: trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php
===================================================================
--- trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php
2011-10-06 14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/tag/SpecialPageTranslationMovePage.php
2011-10-06 14:53:38 UTC (rev 99110)
@@ -62,6 +62,10 @@
*/
protected $old;
+ protected $translationPages;
+
+ protected $sectionPages;
+
public function __construct( $old ) {
parent::__construct( 'Movepage' );
$this->old = $old;
Modified: trunk/extensions/Translate/tag/TranslatablePage.php
===================================================================
--- trunk/extensions/Translate/tag/TranslatablePage.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/tag/TranslatablePage.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -46,6 +46,8 @@
*/
protected $displayTitle = 'Page display title';
+ protected $cachedParse;
+
/**
* @param title Title object for the page
*/
Modified: trunk/extensions/Translate/utils/JsSelectToInput.php
===================================================================
--- trunk/extensions/Translate/utils/JsSelectToInput.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/utils/JsSelectToInput.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -15,7 +15,10 @@
protected $targetId;
/// Id of the \<option> field
protected $sourceId;
- /// XmlSelect
+
+ /**
+ * @var XmlSelect
+ */
protected $select;
/// Id on the button
protected $buttonId;
Modified: trunk/extensions/Translate/utils/MessageTable.php
===================================================================
--- trunk/extensions/Translate/utils/MessageTable.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/utils/MessageTable.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -32,6 +32,9 @@
$this->appendEditLinkParams( 'loadgroup', $group->getId() );
}
+ /**
+ * @param $array array
+ */
public function setEditLinkParams( array $array ) {
$this->editLinkParams = $array;
}
Modified: trunk/extensions/Translate/utils/MessageWebImporter.php
===================================================================
--- trunk/extensions/Translate/utils/MessageWebImporter.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/utils/MessageWebImporter.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -15,10 +15,23 @@
* displays them in pretty way with diffs and finally executes the actions the
user choices.
*/
class MessageWebImporter {
+
+ /**
+ * @var Title
+ */
protected $title;
+
+ /**
+ * @var User
+ */
protected $user;
+
+ /**
+ * @var MessageGroup
+ */
protected $group;
protected $code;
+ protected $time;
/**
* @var OutputPage
Modified: trunk/extensions/Translate/utils/RevTag.php
===================================================================
--- trunk/extensions/Translate/utils/RevTag.php 2011-10-06 14:36:04 UTC (rev
99109)
+++ trunk/extensions/Translate/utils/RevTag.php 2011-10-06 14:53:38 UTC (rev
99110)
@@ -54,7 +54,7 @@
/**
* Converts rt_type field back to the tag name.
- * @param $tag rt_type value
+ * @param $tag int rt_type value
* @return string
*/
public static function typeToTag( $tag ) {
Modified: trunk/extensions/Translate/utils/TranslateYaml.php
===================================================================
--- trunk/extensions/Translate/utils/TranslateYaml.php 2011-10-06 14:36:04 UTC
(rev 99109)
+++ trunk/extensions/Translate/utils/TranslateYaml.php 2011-10-06 14:53:38 UTC
(rev 99110)
@@ -14,6 +14,11 @@
* and generate YAML files with syck or spyc backend.
*/
class TranslateYaml {
+
+ /**
+ * @param $filename string
+ * @return array
+ */
public static function parseGroupFile( $filename ) {
$data = file_get_contents( $filename );
$documents = preg_split( "/^---$/m", $data, -1,
PREG_SPLIT_NO_EMPTY );
Modified: trunk/extensions/Translate/utils/TranslationHelpers.php
===================================================================
--- trunk/extensions/Translate/utils/TranslationHelpers.php 2011-10-06
14:36:04 UTC (rev 99109)
+++ trunk/extensions/Translate/utils/TranslationHelpers.php 2011-10-06
14:53:38 UTC (rev 99110)
@@ -129,7 +129,7 @@
}
if ( $this->group === null ) {
- return;
+ return '';
}
$this->definition = $this->group->getMessage( $this->page,
$this->group->getSourceLanguage() );
@@ -398,13 +398,13 @@
$response = FormatJson::decode( $json );
if ( $json === false ) {
- // Most likely a timeout or other general error
- self::reportTranslationServiceFailure(
$serviceName );
+ // Most likely a timeout or other general error
+ self::reportTranslationServiceFailure( $serviceName );
- return null;
+ return null;
} elseif ( !is_object( $response ) ) {
- error_log( __METHOD__ . ': Unable to parse
reply: ' . strval( $json ) );
- return null;
+ error_log( __METHOD__ . ': Unable to parse reply: ' .
strval( $json ) );
+ return null;
}
if ( $response->responseStatus === 200 ) {
@@ -422,6 +422,8 @@
error_log( __METHOD__ . "($serviceName): " .
$response->responseDetails );
return null;
}
+
+ return null;
}
protected static function makeGoogleQueryParams( $definition, $pair,
$config ) {
@@ -576,7 +578,7 @@
$code = str_replace( '-', '_', wfBCP47( $code ) );
if ( !isset( $pairs[$code] ) ) {
- return;
+ return null;
}
$suggestions = array();
@@ -692,7 +694,7 @@
$placeholder = Html::element( 'div', array( 'class' =>
'mw-translate-messagechecks' ) );
if ( $this->group === null ) {
- return;
+ return null;
}
$page = $this->page;
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
