MediaWiki master
|
This class represents the result of the API operations. More...
Inherits MediaWiki\Api\ApiSerializable.
Public Member Functions | |
__construct ( $maxSize) | |
serializeForApiResult () | |
Allow for adding one ApiResult into another. | |
setErrorFormatter (ApiErrorFormatter $formatter) | |
Public Attributes | |
const | ADD_ON_TOP = 2 |
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first element. | |
const | META_BC_BOOLS = '_BC_bools' |
Key for the 'BC bools' metadata item. | |
const | META_BC_SUBELEMENTS = '_BC_subelements' |
Key for the 'BC subelements' metadata item. | |
const | META_CONTENT = '_content' |
Key for the 'content' metadata item. | |
const | META_INDEXED_TAG_NAME = '_element' |
Key for the 'indexed tag name' metadata item. | |
const | META_KVP_KEY_NAME = '_kvpkeyname' |
Key for the metadata item whose value specifies the name used for the kvp key in the alternative output format with META_TYPE 'kvp' or 'BCkvp', i.e. | |
const | META_KVP_MERGE = '_kvpmerge' |
Key for the metadata item that indicates that the KVP key should be added into an assoc value, i.e. | |
const | META_PRESERVE_KEYS = '_preservekeys' |
Key for the 'preserve keys' metadata item. | |
const | META_SUBELEMENTS = '_subelements' |
Key for the 'subelements' metadata item. | |
const | META_TYPE = '_type' |
Key for the 'type' metadata item. | |
const | NO_SIZE_CHECK = 4 |
For addValue() and similar functions, do not check size while adding a value Don't use this unless you REALLY know what you're doing. | |
const | NO_VALIDATE = self::NO_SIZE_CHECK | 8 |
For addValue(), setValue() and similar functions, do not validate data. | |
const | OVERRIDE = 1 |
Override existing value in addValue(), setValue(), and similar functions. | |
Content | |
reset () | |
Clear the current result data. | |
getResultData ( $path=[], $transforms=[]) | |
Get the result data array. | |
getSize () | |
Get the size of the result, i.e. | |
addValue ( $path, $name, $value, $flags=0) | |
Add value to the output data at the given path. | |
removeValue ( $path, $name, $flags=0) | |
Remove value from the output data at the given path. | |
addContentValue ( $path, $name, $value, $flags=0) | |
Add value to the output data at the given path and mark as META_CONTENT. | |
addParsedLimit ( $moduleName, $limit) | |
Add the numeric limit for a limit=max to the result. | |
static | setValue (array &$arr, $name, $value, $flags=0) |
Add an output value to the array by name. | |
static | unsetValue (array &$arr, $name) |
Remove an output value to the array by name. | |
static | setContentValue (array &$arr, $name, $value, $flags=0) |
Add an output value to the array by name and mark as META_CONTENT. | |
Metadata | |
addContentField ( $path, $name, $flags=0) | |
Set the name of the content field name (META_CONTENT) | |
addSubelementsList ( $path, $names) | |
Causes the elements with the specified names to be output as subelements rather than attributes. | |
removeSubelementsList ( $path, $names) | |
Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements. | |
addIndexedTagName ( $path, $tag) | |
Set the tag name for numeric-keyed values in XML format. | |
addIndexedTagNameRecursive ( $path, $tag) | |
Set indexed tag name on $path and all subarrays. | |
addPreserveKeysList ( $path, $names) | |
Preserve specified keys. | |
removePreserveKeysList ( $path, $names) | |
Don't preserve specified keys. | |
addArrayType ( $path, $tag, $kvpKeyName=null) | |
Set the array data type for a path. | |
addArrayTypeRecursive ( $path, $tag, $kvpKeyName=null) | |
Set the array data type for a path recursively. | |
static | setContentField (array &$arr, $name, $flags=0) |
Set the name of the content field name (META_CONTENT) | |
static | setSubelementsList (array &$arr, $names) |
Causes the elements with the specified names to be output as subelements rather than attributes. | |
static | unsetSubelementsList (array &$arr, $names) |
Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements. | |
static | setIndexedTagName (array &$arr, $tag) |
Set the tag name for numeric-keyed values in XML format. | |
static | setIndexedTagNameRecursive (array &$arr, $tag) |
Set indexed tag name on $arr and all subarrays. | |
static | setPreserveKeysList (array &$arr, $names) |
Preserve specified keys. | |
static | unsetPreserveKeysList (array &$arr, $names) |
Don't preserve specified keys. | |
static | setArrayType (array &$arr, $type, $kvpKeyName=null) |
Set the array data type. | |
static | setArrayTypeRecursive (array &$arr, $type, $kvpKeyName=null) |
Set the array data type recursively. | |
Utility | |
static | isMetadataKey ( $key) |
Test whether a key should be considered metadata. | |
static | stripMetadata ( $data) |
Recursively remove metadata keys from a data array or object. | |
static | stripMetadataNonRecursive ( $data, &$metadata=null) |
Remove metadata keys from a data array or object, non-recursive. | |
static | addMetadataToResultVars ( $vars, $forceHash=true) |
Add the correct metadata to an array of vars we want to export through the API. | |
static | formatExpiry ( $expiry, $infinity='infinity') |
Format an expiry timestamp for API output. | |
static | applyTransformations (array $dataIn, array $transforms) |
Apply transformations to an array, returning the transformed array. | |
This class represents the result of the API operations.
It simply wraps a nested array structure, adding some functions to simplify array's modifications. As various modules execute, they add different pieces of information to this result, structuring it as it will be given to the client.
Each subarray may either be a dictionary - key-value pairs with unique keys, or lists, where the items are added using $data[] = $value notation.
Definition at line 43 of file ApiResult.php.
MediaWiki\Api\ApiResult::__construct | ( | $maxSize | ) |
int | false | $maxSize | Maximum result "size", or false for no limit |
Definition at line 163 of file ApiResult.php.
References MediaWiki\Api\ApiResult\reset().
MediaWiki\Api\ApiResult::addArrayType | ( | $path, | |
$tag, | |||
$kvpKeyName = null ) |
Set the array data type for a path.
array | string | null | $path | See ApiResult::addValue() |
string | $tag | See ApiResult::META_TYPE |
string | null | $kvpKeyName | See ApiResult::META_KVP_KEY_NAME |
Definition at line 748 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setArrayType().
MediaWiki\Api\ApiResult::addArrayTypeRecursive | ( | $path, | |
$tag, | |||
$kvpKeyName = null ) |
Set the array data type for a path recursively.
array | string | null | $path | See ApiResult::addValue() |
string | $tag | See ApiResult::META_TYPE |
string | null | $kvpKeyName | See ApiResult::META_KVP_KEY_NAME |
Definition at line 776 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setArrayTypeRecursive().
MediaWiki\Api\ApiResult::addContentField | ( | $path, | |
$name, | |||
$flags = 0 ) |
Set the name of the content field name (META_CONTENT)
array | string | null | $path | See ApiResult::addValue() |
string | int | $name | Name of the field |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. |
Definition at line 554 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setContentField().
Referenced by MediaWiki\Api\ApiResult\addContentValue().
MediaWiki\Api\ApiResult::addContentValue | ( | $path, | |
$name, | |||
$value, | |||
$flags = 0 ) |
Add value to the output data at the given path and mark as META_CONTENT.
array | string | null | $path | See ApiResult::addValue() |
string | int | $name | See ApiResult::setValue() |
mixed | $value | |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. |
Definition at line 498 of file ApiResult.php.
References $path, MediaWiki\Api\ApiResult\addContentField(), and MediaWiki\Api\ApiResult\addValue().
MediaWiki\Api\ApiResult::addIndexedTagName | ( | $path, | |
$tag ) |
Set the tag name for numeric-keyed values in XML format.
array | string | null | $path | See ApiResult::addValue() |
string | $tag | Tag name |
Definition at line 630 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setIndexedTagName().
MediaWiki\Api\ApiResult::addIndexedTagNameRecursive | ( | $path, | |
$tag ) |
Set indexed tag name on $path and all subarrays.
array | string | null | $path | See ApiResult::addValue() |
string | $tag | Tag name |
Definition at line 661 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setIndexedTagNameRecursive().
|
static |
Add the correct metadata to an array of vars we want to export through the API.
array | $vars | |
bool | $forceHash |
Definition at line 1178 of file ApiResult.php.
References MediaWiki\Api\ApiResult\addMetadataToResultVars().
Referenced by MediaWiki\Api\ApiResult\addMetadataToResultVars(), MediaWiki\Api\ApiExpandTemplates\execute(), and MediaWiki\Api\ApiParse\execute().
MediaWiki\Api\ApiResult::addParsedLimit | ( | $moduleName, | |
$limit ) |
Add the numeric limit for a limit=max to the result.
string | $moduleName | |
int | $limit |
Definition at line 513 of file ApiResult.php.
References MediaWiki\Api\ApiResult\addValue().
MediaWiki\Api\ApiResult::addPreserveKeysList | ( | $path, | |
$names ) |
Preserve specified keys.
array | string | null | $path | See ApiResult::addValue() |
array | string | $names | The element name(s) to preserve |
Definition at line 691 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setPreserveKeysList().
MediaWiki\Api\ApiResult::addSubelementsList | ( | $path, | |
$names ) |
Causes the elements with the specified names to be output as subelements rather than attributes.
array | string | null | $path | See ApiResult::addValue() |
array | string | int | $names | The element name(s) to be output as subelements |
Definition at line 581 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\setSubelementsList().
MediaWiki\Api\ApiResult::addValue | ( | $path, | |
$name, | |||
$value, | |||
$flags = 0 ) |
Add value to the output data at the given path.
Path can be an indexed array, each element specifying the branch at which to add the new value. Setting $path to [ 'a', 'b', 'c' ] is equivalent to data['a']['b']['c'] = $value. If $path is null, the value will be inserted at the data root.
array | string | int | null | $path | |
string | int | null | $name | See ApiResult::setValue() |
mixed | $value | |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. This parameter used to be boolean, and the value of OVERRIDE=1 was specifically chosen so that it would be backwards compatible with the new method signature. |
Definition at line 407 of file ApiResult.php.
References $path, MediaWiki\Api\ApiResult\NO_VALIDATE, MediaWiki\Message\Message\numParam(), and MediaWiki\Api\ApiResult\setValue().
Referenced by MediaWiki\Api\ApiResult\addContentValue(), MediaWiki\Api\ApiResult\addParsedLimit(), MediaWiki\Debug\MWDebug\appendDebugInfoToApiResult(), MediaWiki\Api\ApiPageSet\populateGeneratorData(), and MediaWiki\Api\ApiContinuationManager\setContinuationIntoResult().
|
staticprotected |
Apply transformations to an array, returning the transformed array.
array | $dataIn | |
array | $transforms |
Definition at line 809 of file ApiResult.php.
References MediaWiki\Api\ApiResult\applyTransformations(), MediaWiki\Api\ApiResult\META_CONTENT, MediaWiki\Api\ApiResult\META_KVP_KEY_NAME, MediaWiki\Api\ApiResult\META_TYPE, MediaWiki\Api\ApiResult\setPreserveKeysList(), and MediaWiki\Api\ApiResult\stripMetadataNonRecursive().
Referenced by MediaWiki\Api\ApiResult\applyTransformations(), and MediaWiki\Api\ApiResult\getResultData().
|
static |
Format an expiry timestamp for API output.
string | $expiry | Expiry timestamp, likely from the database |
string | $infinity | Use this string for infinite expiry (only use this to maintain backward compatibility with existing output) |
Definition at line 1233 of file ApiResult.php.
References MediaWiki\MediaWikiServices\getInstance(), wfIsInfinity(), and wfTimestamp().
Referenced by MediaWiki\Api\ApiBlock\execute(), MediaWiki\Api\ApiProtect\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo(), MediaWiki\Api\getExpiryFromParams(), and MediaWiki\Api\getWatchlistExpiry().
MediaWiki\Api\ApiResult::getResultData | ( | $path = [], | |
$transforms = [] ) |
Get the result data array.
The returned value should be considered read-only.
Transformations include:
Custom: (callable) Applied before other transformations. Signature is function ( &$data, &$metadata ), return value is ignored. Called for each nested array.
BC: (array) This transformation does various adjustments to bring the output in line with the pre-1.25 result format. The value array is a list of flags: 'nobool', 'no*', 'nosub'.
Types: (assoc) Apply transformations based on META_TYPE. The values array is an associative array with the following possible keys:
Strip: (string) Strips metadata keys from the result.
array | string | null | $path | Path to fetch, see ApiResult::addValue |
array | $transforms | See above |
Definition at line 252 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\applyTransformations().
MediaWiki\Api\ApiResult::getSize | ( | ) |
Get the size of the result, i.e.
the amount of bytes in it
Definition at line 273 of file ApiResult.php.
|
static |
Test whether a key should be considered metadata.
string | int | $key |
Definition at line 793 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiFeedWatchlist\execute(), and MediaWiki\Api\ApiFormatXml\recXmlPrint().
MediaWiki\Api\ApiResult::removePreserveKeysList | ( | $path, | |
$names ) |
Don't preserve specified keys.
array | string | null | $path | See ApiResult::addValue() |
array | string | $names | The element name(s) to not preserve |
Definition at line 716 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\unsetPreserveKeysList().
MediaWiki\Api\ApiResult::removeSubelementsList | ( | $path, | |
$names ) |
Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements.
array | string | null | $path | See ApiResult::addValue() |
array | string | int | $names | The element name(s) to not be output as subelements |
Definition at line 606 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\unsetSubelementsList().
MediaWiki\Api\ApiResult::removeValue | ( | $path, | |
$name, | |||
$flags = 0 ) |
Remove value from the output data at the given path.
array | string | null | $path | See ApiResult::addValue() |
string | int | null | $name | Index to remove at $path. If null, $path itself is removed. |
int | $flags | Flags used when adding the value |
Definition at line 455 of file ApiResult.php.
References $path, and MediaWiki\Api\ApiResult\unsetValue().
MediaWiki\Api\ApiResult::reset | ( | ) |
Clear the current result data.
Definition at line 192 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\__construct().
MediaWiki\Api\ApiResult::serializeForApiResult | ( | ) |
Allow for adding one ApiResult into another.
Implements MediaWiki\Api\ApiSerializable.
Definition at line 181 of file ApiResult.php.
|
static |
Set the array data type.
array | &$arr | |
string | $type | See ApiResult::META_TYPE |
string | null | $kvpKeyName | See ApiResult::META_KVP_KEY_NAME |
Definition at line 729 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_KVP_KEY_NAME, and MediaWiki\Api\ApiResult\META_TYPE.
Referenced by MediaWiki\Api\ApiResult\addArrayType(), MediaWiki\Api\ApiQuerySiteinfo\appendExtensionTags(), MediaWiki\Api\ApiQuerySiteinfo\appendFunctionHooks(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiQuerySiteinfo\appendLanguageVariants(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaces(), MediaWiki\Api\ApiQuerySiteinfo\appendProtocols(), MediaWiki\Api\ApiQuerySiteinfo\appendRestrictions(), MediaWiki\Api\ApiQuerySiteinfo\appendSubscribedHooks(), MediaWiki\Api\ApiQuerySiteinfo\appendUserGroups(), MediaWiki\Api\ApiQuerySiteinfo\appendVariables(), MediaWiki\Api\ApiComparePages\execute(), MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiParse\execute(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryFileRepoInfo\execute(), MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryUserInfo\getCentralUserInfo(), MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo(), and MediaWiki\Api\ApiResult\setArrayTypeRecursive().
|
static |
Set the array data type recursively.
array | &$arr | |
string | $type | See ApiResult::META_TYPE |
string | null | $kvpKeyName | See ApiResult::META_KVP_KEY_NAME |
Definition at line 760 of file ApiResult.php.
References MediaWiki\Api\ApiResult\setArrayType(), and MediaWiki\Api\ApiResult\setArrayTypeRecursive().
Referenced by MediaWiki\Api\ApiResult\addArrayTypeRecursive(), MediaWiki\Api\ApiQueryFileRepoInfo\execute(), and MediaWiki\Api\ApiResult\setArrayTypeRecursive().
|
static |
Set the name of the content field name (META_CONTENT)
array | &$arr | |
string | int | $name | Name of the field |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. |
Definition at line 533 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_CONTENT.
Referenced by MediaWiki\Api\ApiResult\addContentField(), and MediaWiki\Api\ApiResult\setContentValue().
|
static |
Add an output value to the array by name and mark as META_CONTENT.
array | &$arr | To add $value to |
string | int | $name | Index of $arr to add $value at. |
mixed | $value | |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. |
Definition at line 480 of file ApiResult.php.
References MediaWiki\Api\ApiResult\setContentField(), and MediaWiki\Api\ApiResult\setValue().
Referenced by MediaWiki\Api\ApiQuerySiteinfo\appendLanguages(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaceAliases(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaces(), MediaWiki\Api\ApiQuerySiteinfo\appendSkins(), MediaWiki\Api\ApiComparePages\execute(), MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiQueryAllMessages\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiRsd\formatRsdApiList(), and MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo().
MediaWiki\Api\ApiResult::setErrorFormatter | ( | ApiErrorFormatter | $formatter | ) |
|
static |
Set the tag name for numeric-keyed values in XML format.
array | &$arr | |
string | $tag | Tag name |
Definition at line 617 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_INDEXED_TAG_NAME.
Referenced by MediaWiki\Api\ApiResult\addIndexedTagName(), MediaWiki\Api\ApiQueryBase\addPageSubItems(), MediaWiki\Api\ApiQuerySiteinfo\appendDbReplLagInfo(), MediaWiki\Debug\MWDebug\appendDebugInfoToApiResult(), MediaWiki\Api\ApiQuerySiteinfo\appendExtensions(), MediaWiki\Api\ApiQuerySiteinfo\appendExtensionTags(), MediaWiki\Api\ApiQuerySiteinfo\appendFileExtensions(), MediaWiki\Api\ApiQuerySiteinfo\appendFunctionHooks(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiQuerySiteinfo\appendInstalledClientLibraries(), MediaWiki\Api\ApiQuerySiteinfo\appendInstalledLibraries(), MediaWiki\Api\ApiQuerySiteinfo\appendInterwikiMap(), MediaWiki\Api\ApiQuerySiteinfo\appendLanguages(), MediaWiki\Api\ApiQuerySiteinfo\appendLanguageVariants(), MediaWiki\Api\ApiQuerySiteinfo\appendMagicWords(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaceAliases(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaces(), MediaWiki\Api\ApiQuerySiteinfo\appendProtocols(), MediaWiki\Api\ApiQuerySiteinfo\appendRestrictions(), MediaWiki\Api\ApiQuerySiteinfo\appendSkins(), MediaWiki\Api\ApiQuerySiteinfo\appendSpecialPageAliases(), MediaWiki\Api\ApiQuerySiteinfo\appendSubscribedHooks(), MediaWiki\Api\ApiQuerySiteinfo\appendUserGroups(), MediaWiki\Api\ApiQuerySiteinfo\appendVariables(), MediaWiki\Api\ApiErrorFormatter_BackCompat\arrayFromStatus(), MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiImport\execute(), MediaWiki\Api\ApiMove\execute(), MediaWiki\Api\ApiParamInfo\execute(), MediaWiki\Api\ApiProtect\execute(), MediaWiki\Api\ApiPurge\execute(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFileRepoInfo\execute(), MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiRevisionDelete\execute(), MediaWiki\Api\ApiRsd\execute(), MediaWiki\Api\ApiSetNotificationTimestamp\execute(), MediaWiki\Api\ApiTag\execute(), MediaWiki\Api\ApiUserrights\execute(), MediaWiki\Api\ApiWatch\execute(), MediaWiki\Api\ApiQueryRevisionsBase\extractRevisionInfo(), MediaWiki\Api\ApiQueryRecentChanges\extractRowInfo(), MediaWiki\Api\ApiParamInfo\formatHelpMessages(), MediaWiki\Api\ApiRsd\formatRsdApiList(), MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo(), MediaWiki\Api\ApiOpenSearch\populateResult(), MediaWiki\Api\ApiTag\processIndividual(), MediaWiki\Api\ApiQueryImageInfo\processMetaData(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), and MediaWiki\Api\ApiQueryAllRevisions\run().
|
static |
Set indexed tag name on $arr and all subarrays.
array | &$arr | |
string | $tag | Tag name |
Definition at line 642 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_INDEXED_TAG_NAME, and MediaWiki\Api\ApiResult\setIndexedTagNameRecursive().
Referenced by MediaWiki\Api\ApiResult\addIndexedTagNameRecursive(), and MediaWiki\Api\ApiResult\setIndexedTagNameRecursive().
|
static |
Preserve specified keys.
This prevents XML name mangling and preventing keys from being removed by self::stripMetadata().
array | &$arr | |
array | string | $names | The element name(s) to preserve |
Definition at line 676 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_PRESERVE_KEYS.
Referenced by MediaWiki\Api\ApiResult\addPreserveKeysList(), and MediaWiki\Api\ApiResult\applyTransformations().
|
static |
Causes the elements with the specified names to be output as subelements rather than attributes.
array | &$arr | |
array | string | int | $names | The element name(s) to be output as subelements |
Definition at line 566 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_SUBELEMENTS.
Referenced by MediaWiki\Api\ApiResult\addSubelementsList(), MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiHelp\execute(), MediaWiki\Api\ApiRsd\execute(), MediaWiki\Api\ApiRsd\formatRsdApiList(), and MediaWiki\Api\ApiOpenSearch\populateResult().
|
static |
Add an output value to the array by name.
Verifies that value with the same name has not been added before.
array | &$arr | To add $value to |
string | int | null | $name | Index of $arr to add $value at, or null to use the next numeric index. |
mixed | $value | |
int | $flags | Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP. |
Definition at line 289 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\addValue(), and MediaWiki\Api\ApiResult\setContentValue().
|
static |
Recursively remove metadata keys from a data array or object.
Note this removes all potential metadata keys, not just the defined ones.
array | stdClass | $data |
Definition at line 1050 of file ApiResult.php.
References MediaWiki\Api\ApiResult\stripMetadata().
Referenced by MediaWiki\Api\ApiResult\stripMetadata().
|
static |
Remove metadata keys from a data array or object, non-recursive.
Note this removes all potential metadata keys, not just the defined ones.
array | stdClass | $data | |
array | null | &$metadata | Store metadata here, if provided |
Definition at line 1084 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\applyTransformations().
|
static |
Don't preserve specified keys.
array | &$arr | |
array | string | $names | The element name(s) to not preserve |
Definition at line 703 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_PRESERVE_KEYS.
Referenced by MediaWiki\Api\ApiResult\removePreserveKeysList().
|
static |
Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements.
array | &$arr | |
array | string | int | $names | The element name(s) to not be output as subelements |
Definition at line 593 of file ApiResult.php.
References MediaWiki\Api\ApiResult\META_SUBELEMENTS.
Referenced by MediaWiki\Api\ApiResult\removeSubelementsList().
|
static |
Remove an output value to the array by name.
array | &$arr | To remove $value from |
string | int | $name | Index of $arr to remove |
Definition at line 436 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\removeValue().
const MediaWiki\Api\ApiResult::ADD_ON_TOP = 2 |
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first element.
In case the new value has no name (numerical index), all indexes will be renumbered.
Definition at line 57 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiErrorFormatter_BackCompat\addWarningOrError(), MediaWiki\Api\ApiQuery\execute(), and MediaWiki\Api\ApiContinuationManager\setContinuationIntoResult().
const MediaWiki\Api\ApiResult::META_BC_BOOLS = '_BC_bools' |
Key for the 'BC bools' metadata item.
Value is string[]. Note no setter is provided.
Definition at line 144 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiQuerySiteinfo\appendDefaultOptions(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo(), MediaWiki\Api\ApiQueryImageInfo\processMetaData(), and MediaWiki\Api\ApiFormatXml\recXmlPrint().
const MediaWiki\Api\ApiResult::META_BC_SUBELEMENTS = '_BC_subelements' |
Key for the 'BC subelements' metadata item.
Value is string[]. Note no setter is provided.
Definition at line 151 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiParse\execute(), and MediaWiki\Api\ApiFormatXml\recXmlPrint().
const MediaWiki\Api\ApiResult::META_CONTENT = '_content' |
Key for the 'content' metadata item.
Value is string.
Definition at line 98 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\applyTransformations(), MediaWiki\Api\ApiFormatXml\recXmlPrint(), and MediaWiki\Api\ApiResult\setContentField().
const MediaWiki\Api\ApiResult::META_INDEXED_TAG_NAME = '_element' |
Key for the 'indexed tag name' metadata item.
Value is string.
Definition at line 80 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiFormatXml\recXmlPrint(), MediaWiki\Api\ApiResult\setIndexedTagName(), and MediaWiki\Api\ApiResult\setIndexedTagNameRecursive().
const MediaWiki\Api\ApiResult::META_KVP_KEY_NAME = '_kvpkeyname' |
Key for the metadata item whose value specifies the name used for the kvp key in the alternative output format with META_TYPE 'kvp' or 'BCkvp', i.e.
the "name" in <container>value</container>. Value is string.
Definition at line 127 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\applyTransformations(), and MediaWiki\Api\ApiResult\setArrayType().
const MediaWiki\Api\ApiResult::META_KVP_MERGE = '_kvpmerge' |
Key for the metadata item that indicates that the KVP key should be added into an assoc value, i.e.
{"key":{"val1":"a","val2":"b"}} transforms to {"name":"key","val1":"a","val2":"b"} rather than {"name":"key","value":{"val1":"a","val2":"b"}}. Value is boolean.
Definition at line 137 of file ApiResult.php.
const MediaWiki\Api\ApiResult::META_PRESERVE_KEYS = '_preservekeys' |
Key for the 'preserve keys' metadata item.
Value is string[].
Definition at line 92 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiFormatXml\recXmlPrint(), MediaWiki\Api\ApiResult\setPreserveKeysList(), and MediaWiki\Api\ApiResult\unsetPreserveKeysList().
const MediaWiki\Api\ApiResult::META_SUBELEMENTS = '_subelements' |
Key for the 'subelements' metadata item.
Value is string[].
Definition at line 86 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiParse\execute(), MediaWiki\Api\ApiFormatXml\recXmlPrint(), MediaWiki\Api\ApiResult\setSubelementsList(), and MediaWiki\Api\ApiResult\unsetSubelementsList().
const MediaWiki\Api\ApiResult::META_TYPE = '_type' |
Key for the 'type' metadata item.
Value is one of the following strings:
Definition at line 118 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiQuerySiteinfo\appendNamespaces(), MediaWiki\Api\ApiResult\applyTransformations(), MediaWiki\Api\ApiFormatXml\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiAuthManagerHelper\formatRequests(), MediaWiki\Api\ApiQueryImageInfo\getInfo(), MediaWiki\Api\ApiQueryUserInfo\getRateLimits(), MediaWiki\Api\ApiFormatXml\recXmlPrint(), and MediaWiki\Api\ApiResult\setArrayType().
const MediaWiki\Api\ApiResult::NO_SIZE_CHECK = 4 |
For addValue() and similar functions, do not check size while adding a value Don't use this unless you REALLY know what you're doing.
Values added while the size checking was disabled will never be counted. Ignored for setValue() and similar functions.
Definition at line 66 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiMain\addRequestedFields(), MediaWiki\Api\ApiErrorFormatter_BackCompat\addWarningOrError(), MediaWiki\Api\ApiComparePages\execute(), MediaWiki\Api\ApiFormatXml\execute(), MediaWiki\Api\ApiHelp\execute(), MediaWiki\Api\ApiQuery\execute(), MediaWiki\Api\ApiContinuationManager\setContinuationIntoResult(), and MediaWiki\Api\ApiMain\substituteResultWithError().
const MediaWiki\Api\ApiResult::NO_VALIDATE = self::NO_SIZE_CHECK | 8 |
For addValue(), setValue() and similar functions, do not validate data.
Also disables size checking. If you think you need to use this, you're probably wrong.
Definition at line 74 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiResult\addValue(), and MediaWiki\Api\ApiFormatFeedWrapper\setResult().
const MediaWiki\Api\ApiResult::OVERRIDE = 1 |
Override existing value in addValue(), setValue(), and similar functions.
Definition at line 49 of file ApiResult.php.
Referenced by MediaWiki\Api\ApiErrorFormatter_BackCompat\addWarningOrError().