BlueSpice MediaWiki REL1_27
|
Public Member Functions | |
__construct (StatusValue $sv=null) | |
setResult ($ok, $value=null) | |
getStatusValue () | |
isGood () | |
isOK () | |
warning ($message) | |
error ($message) | |
fatal ($message) | |
getWikiText ($shortContext=false, $longContext=false, $lang=null) | |
getMessage ($shortContext=false, $longContext=false, $lang=null) | |
getHTML ($shortContext=false, $longContext=false, $lang=null) | |
merge ($other, $overwriteValue=false) | |
getErrorsArray () | |
getWarningsArray () | |
getErrorsByType ($type) | |
hasMessage ($message) | |
replaceMessage ($source, $dest) | |
getValue () | |
__get ($name) | |
__set ($name, $value) | |
__toString () | |
__sleep () | |
__wakeup () | |
Static Public Member Functions | |
static | wrap ($sv) |
static | newFatal ($message) |
static | newGood ($value=null) |
Public Attributes | |
$value | |
$success = [] | |
$successCount = 0 | |
$failCount = 0 | |
$cleanCallback = false | |
Protected Member Functions | |
cleanParams (array $params) | |
languageFromParam ($lang) | |
getErrorMessage ($error, $lang=null) | |
getErrorMessageArray ($errors, $lang=null) | |
getStatusArray ($type=false) | |
Protected Attributes | |
$sv | |
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.
The recommended pattern for Status objects is to return a Status object unconditionally, i.e. both on success and on failure – so that the developer of the calling code is reminded that the function can fail, and so that a lack of error-handling will be explicit.
Status::__construct | ( | StatusValue | $sv = null | ) |
StatusValue | $sv | [optional] |
Status::__get | ( | $name | ) |
Backwards compatibility logic
string | $name |
Status::__set | ( | $name, | |
$value | |||
) |
Backwards compatibility logic
string | $name | |
mixed | $value |
Status::__sleep | ( | ) |
Don't save the callback when serializing, because Closures can't be serialized and we're going to clear it in __wakeup anyway.
Status::__toString | ( | ) |
Status::__wakeup | ( | ) |
Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
|
protected |
array | $params |
Status::error | ( | $message | ) |
Status::fatal | ( | $message | ) |
|
protected |
Return the message for a single error.
mixed | $error | 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. |
string | Language | $lang | Language to use for processing messages |
|
protected |
Status::getErrorsArray | ( | ) |
Get the list of errors (but not warnings)
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
Each entry is a map of:
string | $type |
Status::getHTML | ( | $shortContext = false , |
|
$longContext = false , |
|||
$lang = null |
|||
) |
Get the error message as HTML. This is done by parsing the wikitext error message.
string | $shortContext | A short enclosing context message name, to be used when there is a single error |
string | $longContext | A long enclosing context message name, for a list |
string | Language | $lang | Language to use for processing messages |
Status::getMessage | ( | $shortContext = false , |
|
$longContext = false , |
|||
$lang = null |
|||
) |
Get a bullet list of the errors as a Message object.
$shortContext and $longContext can be used to wrap the error list in some text. $shortContext will be preferred when there is a single error; $longContext will be preferred when there are multiple ones. In either case, $1 will be replaced with the list of errors.
$shortContext is assumed to use $1 as an inline parameter: if there is a single item, it will not be made into a list; if there are multiple items, newlines will be inserted around the list. $longContext is assumed to use $1 as a standalone parameter; it will always receive a list.
If both parameters are missing, and there is only one error, no bullet will be added.
string|string[] | $shortContext A message name or an array of message names. | |
string|string[] | $longContext A message name or an array of message names. | |
string | Language | $lang | Language to use for processing messages |
|
protected |
Returns a list of status messages of the given type (or all if false)
string | bool | $type |
Status::getStatusValue | ( | ) |
Returns the wrapped StatusValue object
Status::getValue | ( | ) |
Status::getWarningsArray | ( | ) |
Get the list of warnings (but not errors)
Status::getWikiText | ( | $shortContext = false , |
|
$longContext = false , |
|||
$lang = null |
|||
) |
Get the error list as a wikitext formatted list
string | bool | $shortContext | A short enclosing context message name, to be used when there is a single error |
string | bool | $longContext | A long enclosing context message name, for a list |
string | Language | $lang | Language to use for processing messages |
Status::hasMessage | ( | $message | ) |
Status::isGood | ( | ) |
Returns whether the operation completed and didn't have any error or warnings
Status::isOK | ( | ) |
Returns whether the operation completed
|
protected |
Status::merge | ( | $other, | |
$overwriteValue = false |
|||
) |
|
static |
|
static |
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.
Note, due to the lack of tools for comparing Message objects, this function will not work when using a Message object as the search parameter.
Message | string | $source | Message key or object to search for |
Message | string | $dest | Replacement message key or object |
Status::setResult | ( | $ok, | |
$value = null |
|||
) |
Change operation result
bool | $ok | Whether the operation completed |
mixed | $value |
Status::warning | ( | $message | ) |
|
static |
Succinct helper method to wrap a StatusValue
This is is useful when formatting StatusValue objects:
StatusValue | Status | $sv |