Class which encapsulates message importing. More...

Public Member Functions
	__construct (Title $title=null, $group=null, $code='en')

	getTitle ()
	Wrapper for consistency with SpecialPage.

	setTitle (Title $title)

	getUser ()

	setUser (User $user)

	getGroup ()

	setGroup ( $group)

	getCode ()

	setCode (string $code='en')

	execute (array $messages)

Static Public Member Functions
static	doAction (string $action, MessageGroup $group, string $key, string $code, string $message, string $comment='', User $user=null, int $editFlags=0)
	Perform an action on a given group/key/code.

static	doImport (Title $title, string $message, string $summary, ?User $user, int $editFlags=0)

static	doFuzzy (Title $title, string $message, string $comment, ?User $user, int $editFlags=0)

static	makeTranslationTitle (MessageGroup $group, string $key, string $code)
	Given a group, message key and language code, creates a title for the translation page.

static	makeSectionElement (string $legend, string $type, string $content, Language $lang=null)
	Make section elements.

static	makeTextFuzzy (string $message)
	Prepends translation with fuzzy tag and ensures there is only one of them.

static	escapeNameForPHP (string $name)
	Escape name such that it validates as name and id parameter in html, and so that we can get it back with WebRequest::getVal().

Protected Member Functions
	getAction ()

	doHeader ()

	doFooter ()

	allowProcess ()

	getActions ()

	getDefaultAction (bool $fuzzy, ?string $action)

	checkProcessTime ()

Protected Attributes
	$title

	$user

	$group

	$code

	$time

	$out

	$processingTime = 43
	Maximum processing time in seconds.

Detailed Description

Class which encapsulates message importing.

It scans for changes (new, changed, deleted), displays them in pretty way with diffs and finally executes the actions the user choices.

Author: Niklas Laxström; Siebrand Mazeland

Copyright: Copyright © 2009-2013, Niklas Laxström, Siebrand Mazeland @license GPL-2.0-or-later

Definition at line 34 of file MessageWebImporter.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::__construct	(	Title	$title = null,
			$group = null,
			$code = 'en' )

Parameters

Title \| null	$title
MessageGroup \| string \| null	$group
string	$code

Definition at line 55 of file MessageWebImporter.php.

Member Function Documentation

◆ allowProcess()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::allowProcess ( )

protected

Definition at line 121 of file MessageWebImporter.php.

◆ checkProcessTime()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::checkProcessTime ( )

protected

Definition at line 410 of file MessageWebImporter.php.

◆ doAction()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::doAction	(	string	$action,
		MessageGroup	$group,
		string	$key,
		string	$code,
		string	$message,
		string	$comment = '',
		User	$user = null,
		int	$editFlags = 0 )

static

Perform an action on a given group/key/code.

Parameters

string	$action	Options: 'import', 'conflict' or 'ignore'
MessageGroup	$group
string	$key	Message key
string	$code	Language code
string	$message	Contents for the $key/code combination
string	$comment	Edit summary (default: empty) - see Article::doEdit
User \| null	$user	User that will make the edit (default: null - RequestContext user). See Article::doEdit.
int	$editFlags	Integer bitfield: see Article::doEdit

Exceptions

MWException

Returns: array Action result

Definition at line 372 of file MessageWebImporter.php.

◆ doFooter()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::doFooter ( )

protected

Definition at line 117 of file MessageWebImporter.php.

◆ doFuzzy()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::doFuzzy	(	Title	$title,
		string	$message,
		string	$comment,
		?User	$user,
		int	$editFlags = 0 )

static

Returns: string[]

Definition at line 447 of file MessageWebImporter.php.

◆ doHeader()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::doHeader ( )

protected

Definition at line 103 of file MessageWebImporter.php.

◆ doImport()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::doImport	(	Title	$title,
		string	$message,
		string	$summary,
		?User	$user,
		int	$editFlags = 0 )

static

Exceptions

MWException

Returns: string[]

Definition at line 418 of file MessageWebImporter.php.

◆ escapeNameForPHP()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::escapeNameForPHP ( string $name )

static

Escape name such that it validates as name and id parameter in html, and so that we can get it back with WebRequest::getVal().

Especially dot and spaces are difficult for the latter.

Definition at line 594 of file MessageWebImporter.php.

◆ execute()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::execute ( array $messages )

Definition at line 147 of file MessageWebImporter.php.

◆ getAction()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getAction ( )

protected

Definition at line 99 of file MessageWebImporter.php.

◆ getActions()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getActions ( )

protected

Definition at line 131 of file MessageWebImporter.php.

◆ getCode()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getCode ( )

Definition at line 91 of file MessageWebImporter.php.

◆ getDefaultAction()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getDefaultAction	(	bool	$fuzzy,
		?string	$action )

protected

Definition at line 139 of file MessageWebImporter.php.

◆ getGroup()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getGroup ( )

Definition at line 78 of file MessageWebImporter.php.

◆ getTitle()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getTitle ( )

Wrapper for consistency with SpecialPage.

Definition at line 62 of file MessageWebImporter.php.

◆ getUser()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::getUser ( )

Definition at line 70 of file MessageWebImporter.php.

◆ makeSectionElement()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::makeSectionElement	(	string	$legend,
		string	$type,
		string	$content,
		Language	$lang = null )

static

Make section elements.

Parameters

string	$legend	Legend as raw html.
string	$type	Contents of type class.
string	$content	Contents as raw html.
Language \| null	$lang	The language in which the text is written.

Returns: string Section element as html.

Definition at line 555 of file MessageWebImporter.php.

◆ makeTextFuzzy()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::makeTextFuzzy ( string $message )

static

Prepends translation with fuzzy tag and ensures there is only one of them.

Parameters

string $message Message content

Returns: string Message prefixed with TRANSLATE_FUZZY tag

Definition at line 583 of file MessageWebImporter.php.

◆ makeTranslationTitle()

static MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::makeTranslationTitle	(	MessageGroup	$group,
		string	$key,
		string	$code )

static

Given a group, message key and language code, creates a title for the translation page.

Parameters

MessageGroup	$group
string	$key	Message key
string	$code	Language code

Returns: Title

Definition at line 540 of file MessageWebImporter.php.

◆ setCode()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::setCode ( string $code = 'en' )

Definition at line 95 of file MessageWebImporter.php.

◆ setGroup()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::setGroup ( $group )

Parameters

MessageGroup | string $group MessageGroup object or group ID

Definition at line 83 of file MessageWebImporter.php.

◆ setTitle()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::setTitle ( Title $title )

Definition at line 66 of file MessageWebImporter.php.

◆ setUser()

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::setUser ( User $user )

Definition at line 74 of file MessageWebImporter.php.

Member Data Documentation

◆ $code

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$code

protected

Definition at line 41 of file MessageWebImporter.php.

◆ $group

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$group

protected

Definition at line 40 of file MessageWebImporter.php.

◆ $out

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$out

protected

Definition at line 44 of file MessageWebImporter.php.

◆ $processingTime

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$processingTime = 43

protected

Maximum processing time in seconds.

Definition at line 48 of file MessageWebImporter.php.

◆ $time

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$time

protected

Definition at line 42 of file MessageWebImporter.php.

◆ $title

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$title

protected

Definition at line 36 of file MessageWebImporter.php.

◆ $user

MediaWiki\Extension\Translate\Synchronization\MessageWebImporter::$user

protected

Definition at line 38 of file MessageWebImporter.php.

The documentation for this class was generated from the following file:

src/Synchronization/MessageWebImporter.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowProcess()

◆ checkProcessTime()

◆ doAction()

◆ doFooter()

◆ doFuzzy()

◆ doHeader()

◆ doImport()

◆ escapeNameForPHP()

◆ execute()

◆ getAction()

◆ getActions()

◆ getCode()

◆ getDefaultAction()

◆ getGroup()

◆ getTitle()

◆ getUser()

◆ makeSectionElement()

◆ makeTextFuzzy()

◆ makeTranslationTitle()

◆ setCode()

◆ setGroup()

◆ setTitle()

◆ setUser()

Member Data Documentation

◆ $code

◆ $group

◆ $out

◆ $processingTime

◆ $time

◆ $title

◆ $user