A StatusValue for upload verification errors. More...

Collaboration diagram for UploadVerificationStatus:

[legend]

Public Member Functions
	asApiMessage ()

	getInvalidParameter ()

	isRecoverableError ()

	setApiCode (string $apiCode)

	setApiData (array $apiData)

	setInvalidParameter (string $invalidParameter)

	setRecoverableError (bool $recoverableError)

Public Member Functions inherited from StatusValue
	__toString ()
	Returns a string representation of the status for debugging.

	error ( $message,... $parameters)
	Add an error, do not set fatal flag This can be used for non-fatal errors.

	fatal ( $message,... $parameters)
	Add an error and set OK to false, indicating that the operation as a whole was fatal.

	getErrors ()
	Get the list of errors.

	getErrorsByType ( $type)
	Returns a list of status messages of the given type.

	getMessages (?string $type=null)
	Returns a list of error messages, optionally only those of the given type.

	getValue ()

	hasMessage (string $message)
	Returns true if the specified message is present as a warning or error.

	hasMessagesExcept (string ... $messages)
	Returns true if any other message than the specified ones 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 (string $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.

	setOK ( $ok)
	Change operation status.

	setResult ( $ok, $value=null)
	Change operation result.

	splitByErrorType ()
	Splits this StatusValue object into two new StatusValue objects, one which contains only the error messages, and one that contains the warnings, only.

	warning ( $message,... $parameters)
	Add a new warning.

Additional Inherited Members
Static Public Member Functions inherited from StatusValue
static	newFatal ( $message,... $parameters)
	Factory function for fatal errors.

static	newGood ( $value=null)
	Factory function for good results.

Public Attributes inherited from StatusValue
int	$failCount = 0
	Counter for batch operations.

mixed	$statusData
	arbitrary extra data about the operation

bool[]	$success = []
	Map of (key => bool) to indicate success of each part of batch operations.

int	$successCount = 0
	Counter for batch operations.

mixed	$value

Protected Member Functions inherited from StatusValue
	getStatusArray ( $type=false)
	Returns a list of status messages of the given type (or all if false)

Protected Attributes inherited from StatusValue
array[]	$errors = []

bool	$ok = true