Mock for the input/output of FetchText. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\SemiMockedFetchText:

[legend]

Collaboration diagram for MediaWiki\Tests\Maintenance\SemiMockedFetchText:

[legend]

Public Member Functions
	getStdin ( $len=null)
	Return input from stdin.

	mockGetInvocations ()
	Gets invocation counters for mocked methods.

	mockStdin ( $stdin)
	Data for the fake stdin.

Public Member Functions inherited from FetchText
	__construct ()
	Default constructor.

	execute ()
	returns a string containing the following in order: textid \n length of text (-1 on error = failure to retrieve/unserialize/gunzip/etc) \n text (may be empty)

Public Member Functions inherited from Maintenance
function	__construct ()

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

function	execute ()

	finalSetup ()
	Handle some last-minute setup here.

	getConfig ()

	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

	getName ()
	Get the script's name.

	globals ()
	Potentially debug globals.

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.

	loadSettings ()
	Generic setup for most installs.

	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments.

	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts.

	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support.

	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records.

	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script.

	setAgentAndTriggers ()
	Set triggers like when to try to run deferred updates.

	setConfig (Config $config)

	setDB (IDatabase $db)
	Sets database object to be returned by getDB().

	setup ()
	Do some sanity checking and basic setup.

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking.

	updateSearchIndexForPage ( $dbw, $pageId)
	Update the searchindex table for a given pageid.

Private Attributes
array	$mockInvocations = [ 'getStdin' => 0 ]
	Invocation counters for the mocked aspects.

bool	$mockSetUp = false
	Whether or not a text for stdin has been provided.

string null	$mockStdinText = null
	Text to pass as stdin.

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
static	getTermSize ()
	Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).

static	posix_isatty ( $fd)
	Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.

static	readconsole ( $prompt='> ')
	Prompt the console for input.

static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory.

static	setLBFactoryTriggers (LBFactory $LBFactory, Config $config)

static	shouldExecute ()
	Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)

Public Attributes inherited from Maintenance
resource	$fileHandle
	Used when creating separate schema files.

array	$orderedOptions = []
	Used to read the options in the order they were passed.

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type.

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Member Functions inherited from Maintenance
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set)

	addArg ( $arg, $description, $required=true)
	Add some args that are needed.

	addDefaultParams ()
	Add the default parameters to the scripts.

	addDescription ( $text)
	Set the description text.

	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script.

	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed.

	afterFinalSetup ()
	Execute a callback function at the end of initialisation.

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transcation on a DB.

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation on a DB handle and wait for replica DBs to catch up.

	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

	deleteOption ( $name)
	Remove an option.

	error ( $err, $die=0)
	Throw an error to the user.

	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.

	getArg ( $argId=0, $default=null)
	Get an argument.

	getBatchSize ()
	Returns batch size.

	getDB ( $db, $groups=[], $wiki=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

	getOption ( $name, $default=null)
	Get an option, or return the default.

	hasArg ( $argId=0)
	Does a given argument exist?

	hasOption ( $name)
	Checks to see if a particular option exists.

	loadSpecialVars ()
	Handle the special variables that are global to all scripts.

	maybeHelp ( $force=false)
	Maybe show the help.

	output ( $out, $channel=null)
	Throw some output to the user.

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run.

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transcation on a DB handle.

	setAllowUnregisteredOptions ( $allow)
	Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.

	setBatchSize ( $s=0)
	Set the batch size.

	supportsOption ( $name)
	Checks to see if a particular option in supported.

	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Mock for the input/output of FetchText.

FetchText internally tries to access stdin and stdout. We mock those aspects for testing.

Definition at line 21 of file fetchTextTest.php.

Member Function Documentation

◆ getStdin()

MediaWiki\Tests\Maintenance\SemiMockedFetchText::getStdin ( $len = null )

Return input from stdin.

Parameters

int | null $len The number of bytes to read. If null, just return the handle. Maintenance::STDIN_ALL returns the full length

Returns: mixed

Reimplemented from Maintenance.

Definition at line 61 of file fetchTextTest.php.

◆ mockGetInvocations()

MediaWiki\Tests\Maintenance\SemiMockedFetchText::mockGetInvocations ( )

Gets invocation counters for mocked methods.

Returns: array An array, whose keys are function names. The corresponding values denote the number of times the function has been invoked.

Definition at line 54 of file fetchTextTest.php.

References MediaWiki\Tests\Maintenance\SemiMockedFetchText\$mockInvocations.

◆ mockStdin()

MediaWiki\Tests\Maintenance\SemiMockedFetchText::mockStdin ( $stdin )

Data for the fake stdin.

Parameters

string $stdin The string to be used instead of stdin

Definition at line 43 of file fetchTextTest.php.

Member Data Documentation

◆ $mockInvocations

array MediaWiki\Tests\Maintenance\SemiMockedFetchText::$mockInvocations = [ 'getStdin' => 0 ]

private

Invocation counters for the mocked aspects.

Definition at line 36 of file fetchTextTest.php.

Referenced by MediaWiki\Tests\Maintenance\SemiMockedFetchText\mockGetInvocations().

◆ $mockSetUp

bool MediaWiki\Tests\Maintenance\SemiMockedFetchText::$mockSetUp = false

private

Whether or not a text for stdin has been provided.

Definition at line 31 of file fetchTextTest.php.

◆ $mockStdinText

string null MediaWiki\Tests\Maintenance\SemiMockedFetchText::$mockStdinText = null

private

Text to pass as stdin.

Definition at line 26 of file fetchTextTest.php.

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

tests/phpunit/maintenance/fetchTextTest.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getStdin()

◆ mockGetInvocations()

◆ mockStdin()

Member Data Documentation

◆ $mockInvocations

◆ $mockSetUp

◆ $mockStdinText