LocalisationUpdate\Updater Class Reference

Executes the localisation update. More...

Public Member Functions
	execute (Finder $finder, ReaderFactory $readerFactory, FetcherFactory $fetcherFactory, array $repos)
	expandRemotePath ( $info, $repos)
	Expands repository relative path to full url with the given repository patterns.
	fetchFiles (FetcherFactory $factory, $path)
	Fetches files from given Url pattern.
	findChangedTranslations ( $origin, $remote, $blacklist=[])
	Find new and changed translations in $remote and returns them.
	isDirectory ( $path)
	Whether the path is a pattern and thus we need to use appropriate code for fetching directories.
	readMessages (ReaderFactory $readerFactory, array $files)
	Parses translations from given list of files.

Detailed Description

Executes the localisation update.

Definition at line 13 of file Updater.php.

Member Function Documentation

execute()

LocalisationUpdate\Updater::execute	(	Finder	$finder,
		ReaderFactory	$readerFactory,
		FetcherFactory	$fetcherFactory,
		array	$repos )

Definition at line 126 of file Updater.php.

expandRemotePath()

LocalisationUpdate\Updater::expandRemotePath	(		$info,
			$repos )

Expands repository relative path to full url with the given repository patterns.

Extra variables in $info are used as variables and will be replaced the pattern.

Parameters

array	$info	Component information.
array	$repos	Repository information.

Returns

string

Definition at line 35 of file Updater.php.

References $keys.

fetchFiles()

LocalisationUpdate\Updater::fetchFiles	(	FetcherFactory	$factory,
			$path )

Fetches files from given Url pattern.

Parameters

FetcherFactory	$factory	Factory to construct fetchers.
string	$path	Url to the file or pattern of files.

Returns

array List of Urls with file contents as path.

Definition at line 113 of file Updater.php.

References LocalisationUpdate\FetcherFactory\getFetcher().

findChangedTranslations()

LocalisationUpdate\Updater::findChangedTranslations	(		$origin,
			$remote,
			$blacklist = [] )

Find new and changed translations in $remote and returns them.

Parameters

array	$origin
array	$remote
array	$blacklist	Array of message keys to ignore, keys as as array keys.

Returns

array

Definition at line 92 of file Updater.php.

References $value.

isDirectory()

LocalisationUpdate\Updater::isDirectory

(

$path

)

Whether the path is a pattern and thus we need to use appropriate code for fetching directories.

Parameters

string

$path

Url

Returns

bool

Definition at line 21 of file Updater.php.

readMessages()

LocalisationUpdate\Updater::readMessages	(	ReaderFactory	$readerFactory,
		array	$files )

Parses translations from given list of files.

Parameters

ReaderFactory	$readerFactory	Factory to construct parsers.
array	$files	List of files with their contents as array values.

Returns

array List of translations indexed by language code.

Definition at line 57 of file Updater.php.

References $code, $e, and $messages.

---

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

• extensions/LocalisationUpdate/Updater.php