Generic operation result class Has warning/error list, boolean status and arbitrary value. More...

Inheritance diagram for Status:

Public Member Functions
	__wakeup ()
	Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
	error ($message)
	Add an error, do not set fatal flag This can be used for non-fatal errors.
	fatal ($message)
	Add an error and set OK to false, indicating that the operation as a whole was fatal.
	getErrorsArray ()
	Get the list of errors (but not warnings)
	getErrorsByType ($type)
	Returns a list of status messages of the given type, with message and params left untouched, like a sane version of getStatusArray.
	getMessage ()
	Backward compatibility function for WikiError -> Status migration.
	getValue ()
	getWarningsArray ()
	Get the list of warnings (but not errors)
	getWikiText ($shortContext=false, $longContext=false)
	Get the error list as a wikitext formatted list.
	getWikiTextArray ($errors)
	Return an array with the wikitext for each item in the array.
	hasMessage ($msg)
	Returns true if the specified message is present as a warning or error.
	isGood ()
	Returns whether the operation completed and didn't have any error or warnings.
	isOK ()
	Returns whether the operation completed.
	merge ($other, $overwriteValue=false)
	Merge another status object into this one.
	replaceMessage ($source, $dest)
	If the specified source message exists, replace it with the specified destination message, but keep the same parameters as in the original error.
	setResult ($ok, $value=null)
	Change operation result.
	warning ($message)
	Add a new warning.
Static Public Member Functions
static	newFatal ($message)
	Factory function for fatal errors.
static	newGood ($value=null)
	Factory function for good results.
Public Attributes
	$cleanCallback = false
	$errors = array()
	$failCount = 0
	$ok = true
	$success = array()
	Array to indicate which items of the batch operations were successful.
	$successCount = 0
	Counters for batch operations.
	$value
Protected Member Functions
	cleanParams ($params)
	getStatusArray ($type)
	Returns a list of status messages of the given type.
	getWikiTextForError ($error)
	Return the wiki text for a single error.

Detailed Description

Generic operation result class Has warning/error list, boolean status and arbitrary value.

"Good" means the operation was completed with no warnings or errors.

"OK" means the operation was partially or wholly completed.

An operation which is not OK should have errors so that the user can be informed as to what went wrong. Calling the fatal() function sets an error message and simultaneously switches off the OK flag.

Definition at line 35 of file Status.php.

Member Function Documentation

Status::__wakeup ( )

Sanitize the callback parameter on wakeup, to avoid arbitrary execution.

Definition at line 148 of file Status.php.

Status::cleanParams ( $ params ) [protected]

Parameters:

$params array

Returns:: array

Definition at line 156 of file Status.php.

References $params.

Referenced by getWikiTextForError().

Status::error ( $ message )

Add an error, do not set fatal flag This can be used for non-fatal errors.

Parameters:

$message String: message name

Definition at line 122 of file Status.php.

References $params.

Status::fatal ( $ message )

Add an error and set OK to false, indicating that the operation as a whole was fatal.

Parameters:

$message String: message name

Definition at line 136 of file Status.php.

References $params.

Referenced by SwiftFileBackend\doCopyInternal(), SwiftFileBackend\doDeleteInternal(), SwiftFileBackend\doMoveInternal(), SwiftFileBackend\doStoreInternal(), SwiftFileBackend\doStreamFile(), and getWikiText().

Status::getErrorsArray ( )

Get the list of errors (but not warnings)

Returns:: Array

Definition at line 258 of file Status.php.

References getStatusArray().

Referenced by CliInstaller\showStatusMessage().

Status::getErrorsByType ( $ type )

Returns a list of status messages of the given type, with message and params left untouched, like a sane version of getStatusArray.

Parameters:

$type String

Returns:: Array

Definition at line 299 of file Status.php.

References $result.

Status::getMessage ( )

Backward compatibility function for WikiError -> Status migration.

Returns:: String

Definition at line 348 of file Status.php.

References getWikiText().

Status::getStatusArray ( $ type ) [protected]

Returns a list of status messages of the given type.

Parameters:

$type String

Returns:: Array

Definition at line 277 of file Status.php.

References $result.

Referenced by getErrorsArray(), and getWarningsArray().

Status::getValue ( )

Returns:: mixed

Definition at line 355 of file Status.php.

Status::getWarningsArray ( )

Get the list of warnings (but not errors)

Returns:: Array

Definition at line 267 of file Status.php.

References getStatusArray().

Referenced by CliInstaller\showStatusMessage().

Status::getWikiText	(	$	shortContext = `false`,
		$	longContext = `false`
	)

Get the error list as a wikitext formatted list.

Parameters:

$shortContext	String: a short enclosing context message name, to be used when there is a single error
$longContext	String: a long enclosing context message name, for a list

Returns:: String

Definition at line 175 of file Status.php.

References $s, fatal(), getWikiTextArray(), getWikiTextForError(), and wfMessage().

Referenced by getMessage().

Status::getWikiTextArray ( $ errors )

Return an array with the wikitext for each item in the array.

Parameters:

$errors Array

Returns:: Array

Definition at line 233 of file Status.php.

References $errors.

Referenced by getWikiText().

Status::getWikiTextForError ( $ error ) [protected]

Return the wiki text for a single error.

Parameters:

$error Mixed With an array & two values keyed by 'message' and 'params', use those keys-value pairs. Otherwise, if its an array, just use the first value as the message and the remaining items as the params.

Returns:: String

Definition at line 213 of file Status.php.

References cleanParams(), and wfMessage().

Referenced by getWikiText().

Status::hasMessage ( $ msg )

Returns true if the specified message is present as a warning or error.

Parameters:

$msg	String: message name

Returns:: Boolean

Definition at line 315 of file Status.php.

Status::isGood ( )

Returns whether the operation completed and didn't have any error or warnings.

Returns:: Boolean

Definition at line 90 of file Status.php.

Status::isOK ( )

Returns whether the operation completed.

Returns:: Boolean

Definition at line 99 of file Status.php.

Status::merge	(	$	other,
		$	overwriteValue = `false`
	)

Merge another status object into this one.

Parameters:

$other	Status Other Status object
$overwriteValue	Boolean: whether to override the "value" member

Definition at line 243 of file Status.php.

Referenced by SwiftFileBackend\doPrepareInternal(), SwiftFileBackend\doPublishInternal(), SwiftFileBackend\doSecureInternal(), FileOpBatch\runBatchParallel(), and FileOpBatch\runBatchSeries().

static Status::newFatal ( $ message ) [static]

Factory function for fatal errors.

Parameters:

$message String: message name

Returns:: Status

Reimplemented in FileRepoStatus.

Definition at line 53 of file Status.php.

References $params, and $result.

Referenced by ImportStreamSource\__construct(), UploadFromChunks\addChunk(), ImportReporter\close(), UploadBase\convertVerifyErrorToStatus(), SpecialImport\doImport(), CliInstaller\execute(), ZipDirectoryReader\execute(), PoolCounterWork\execute(), UploadFromUrl\fetchFile(), UserrightsPage\fetchUser(), SpecialUnlockdb\onSubmit(), SpecialLockdb\onSubmit(), UploadFromUrl\performUpload(), UploadFromUrl\reallyFetchFile(), UserMailer\send(), UserMailer\sendWithPear(), PostgresInstaller\setupPLpgSQL(), PostgresInstaller\setupSchema(), PostgresInstaller\setupUser(), WebInstaller_DBConnect\submit(), PostgresInstaller\submitConnectForm(), OracleInstaller\submitConnectForm(), MysqlInstaller\submitConnectForm(), PostgresInstaller\submitSettingsForm(), MysqlInstaller\submitSettingsForm(), and SpecialUploadStash\tryClearStashedUploads().

static Status::newGood ( $ value = null ) [static]

Factory function for good results.

Parameters:

$value Mixed

Returns:: Status

Definition at line 67 of file Status.php.

References $result, and $value.

Status::replaceMessage	(	$	source,
		$	dest
	)

If the specified source message exists, replace it with the specified destination message, but keep the same parameters as in the original error.

Return true if the replacement was done, false otherwise.

Returns:: bool

Definition at line 332 of file Status.php.

References $source.

Status::setResult	(	$	ok,
		$	value = `null`
	)

Change operation result.

Parameters:

$ok	Boolean: whether the operation completed
$value	Mixed

Definition at line 79 of file Status.php.

References $ok, and $value.

Status::warning ( $ message )

Add a new warning.

Parameters:

$message String: message name

Definition at line 108 of file Status.php.

References $params.

Member Data Documentation

Status::$cleanCallback = false

Definition at line 45 of file Status.php.

Status::$errors = array()

Definition at line 44 of file Status.php.

Referenced by getWikiTextArray().

Status::$failCount = 0

Definition at line 40 of file Status.php.

Status::$ok = true

Definition at line 36 of file Status.php.

Referenced by setResult().

Status::$success = array()

Array to indicate which items of the batch operations were successful.

Definition at line 42 of file Status.php.

Status::$successCount = 0

Counters for batch operations.

Definition at line 40 of file Status.php.

Status::$value

Definition at line 37 of file Status.php.

Referenced by FileRepoStatus\newGood(), newGood(), and setResult().

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

includes/Status.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation