MediaWiki  master
ApiResult Class Reference

This class represents the result of the API operations. More...

Inheritance diagram for ApiResult:
Collaboration diagram for ApiResult:

Public Member Functions

 __construct ( $maxSize)
 
 serializeForApiResult ()
 Allow for adding one ApiResult into another. More...
 
 setErrorFormatter (ApiErrorFormatter $formatter)
 Set the error formatter. More...
 

Public Attributes

 $mainForContinuation
 
 $maxSize
 
 $size
 
const ADD_ON_TOP = 2
 For addValue(), setValue() and similar functions, if the value does not exist, add it as the first element. More...
 
const META_BC_BOOLS = '_BC_bools'
 Key for the 'BC bools' metadata item. More...
 
const META_BC_SUBELEMENTS = '_BC_subelements'
 Key for the 'BC subelements' metadata item. More...
 
const META_CONTENT = '_content'
 Key for the 'content' metadata item. More...
 
const META_INDEXED_TAG_NAME = '_element'
 Key for the 'indexed tag name' metadata item. More...
 
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. More...
 
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. More...
 
const META_PRESERVE_KEYS = '_preservekeys'
 Key for the 'preserve keys' metadata item. More...
 
const META_SUBELEMENTS = '_subelements'
 Key for the 'subelements' metadata item. More...
 
const META_TYPE = '_type'
 Key for the 'type' metadata item. More...
 
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. More...
 
const NO_VALIDATE = self::NO_SIZE_CHECK | 8
 For addValue(), setValue() and similar functions, do not validate data. More...
 
const OVERRIDE = 1
 Override existing value in addValue(), setValue(), and similar functions. More...
 

Private Attributes

 $checkingSize
 
 $data
 
 $errorFormatter
 

Content

 reset ()
 Clear the current result data. More...
 
 getResultData ( $path=[], $transforms=[])
 Get the result data array. More...
 
 getSize ()
 Get the size of the result, i.e. More...
 
 addValue ( $path, $name, $value, $flags=0)
 Add value to the output data at the given path. More...
 
 removeValue ( $path, $name, $flags=0)
 Remove value from the output data at the given path. More...
 
 addContentValue ( $path, $name, $value, $flags=0)
 Add value to the output data at the given path and mark as META_CONTENT. More...
 
 addParsedLimit ( $moduleName, $limit)
 Add the numeric limit for a limit=max to the result. More...
 
static setValue (array &$arr, $name, $value, $flags=0)
 Add an output value to the array by name. More...
 
static unsetValue (array &$arr, $name)
 Remove an output value to the array by name. More...
 
static setContentValue (array &$arr, $name, $value, $flags=0)
 Add an output value to the array by name and mark as META_CONTENT. More...
 
static validateValue ( $value)
 Validate a value for addition to the result. More...
 

Metadata

 addContentField ( $path, $name, $flags=0)
 Set the name of the content field name (META_CONTENT) More...
 
 addSubelementsList ( $path, $names)
 Causes the elements with the specified names to be output as subelements rather than attributes. More...
 
 removeSubelementsList ( $path, $names)
 Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements. More...
 
 addIndexedTagName ( $path, $tag)
 Set the tag name for numeric-keyed values in XML format. More...
 
 addIndexedTagNameRecursive ( $path, $tag)
 Set indexed tag name on $path and all subarrays. More...
 
 addPreserveKeysList ( $path, $names)
 Preserve specified keys. More...
 
 removePreserveKeysList ( $path, $names)
 Don't preserve specified keys. More...
 
 addArrayType ( $path, $tag, $kvpKeyName=null)
 Set the array data type for a path. More...
 
 addArrayTypeRecursive ( $path, $tag, $kvpKeyName=null)
 Set the array data type for a path recursively. More...
 
static setContentField (array &$arr, $name, $flags=0)
 Set the name of the content field name (META_CONTENT) More...
 
static setSubelementsList (array &$arr, $names)
 Causes the elements with the specified names to be output as subelements rather than attributes. More...
 
static unsetSubelementsList (array &$arr, $names)
 Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements. More...
 
static setIndexedTagName (array &$arr, $tag)
 Set the tag name for numeric-keyed values in XML format. More...
 
static setIndexedTagNameRecursive (array &$arr, $tag)
 Set indexed tag name on $arr and all subarrays. More...
 
static setPreserveKeysList (array &$arr, $names)
 Preserve specified keys. More...
 
static unsetPreserveKeysList (array &$arr, $names)
 Don't preserve specified keys. More...
 
static setArrayType (array &$arr, $type, $kvpKeyName=null)
 Set the array data type. More...
 
static setArrayTypeRecursive (array &$arr, $type, $kvpKeyName=null)
 Set the array data type recursively. More...
 

Utility

static isMetadataKey ( $key)
 Test whether a key should be considered metadata. More...
 
static stripMetadata ( $data)
 Recursively remove metadata keys from a data array or object. More...
 
static stripMetadataNonRecursive ( $data, &$metadata=null)
 Remove metadata keys from a data array or object, non-recursive. More...
 
static addMetadataToResultVars ( $vars, $forceHash=true)
 Add the correct metadata to an array of vars we want to export through the API. More...
 
static formatExpiry ( $expiry, $infinity='infinity')
 Format an expiry timestamp for API output. More...
 
static size ( $value)
 Get the 'real' size of a result item. More...
 
static applyTransformations (array $dataIn, array $transforms)
 Apply transformations to an array, returning the transformed array. More...
 
path ( $path, $create='append')
 Return a reference to the internal data at $path. More...
 

Detailed Description

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.

Since
1.25 this is no longer a subclass of ApiBase

Definition at line 35 of file ApiResult.php.

Constructor & Destructor Documentation

◆ __construct()

ApiResult::__construct (   $maxSize)
Parameters
int | bool$maxSizeMaximum result "size", or false for no limit
Since
1.25 Takes an integer|bool rather than an ApiMain

Definition at line 155 of file ApiResult.php.

References $maxSize, reset(), and wfDeprecated().

Member Function Documentation

◆ addArrayType()

ApiResult::addArrayType (   $path,
  $tag,
  $kvpKeyName = null 
)

Set the array data type for a path.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string$tagSee ApiResult::META_TYPE
string | null$kvpKeyNameSee ApiResult::META_KVP_KEY_NAME

Definition at line 747 of file ApiResult.php.

References $path, and path().

◆ addArrayTypeRecursive()

ApiResult::addArrayTypeRecursive (   $path,
  $tag,
  $kvpKeyName = null 
)

Set the array data type for a path recursively.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string$tagSee ApiResult::META_TYPE
string | null$kvpKeyNameSee ApiResult::META_KVP_KEY_NAME

Definition at line 775 of file ApiResult.php.

References $path, and path().

◆ addContentField()

ApiResult::addContentField (   $path,
  $name,
  $flags = 0 
)

Set the name of the content field name (META_CONTENT)

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string | int$nameName of the field
int$flagsZero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.

Definition at line 553 of file ApiResult.php.

References $name, $path, and path().

Referenced by addContentValue().

◆ addContentValue()

ApiResult::addContentValue (   $path,
  $name,
  $value,
  $flags = 0 
)

Add value to the output data at the given path and mark as META_CONTENT.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string | int$nameSee ApiResult::setValue()
mixed$value
int$flagsZero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.
Returns
bool True if $value fits in the result, false if not

Definition at line 496 of file ApiResult.php.

References $name, $path, $value, addContentField(), addValue(), and null.

◆ addIndexedTagName()

ApiResult::addIndexedTagName (   $path,
  $tag 
)

Set the tag name for numeric-keyed values in XML format.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string$tagTag name

Definition at line 629 of file ApiResult.php.

References $path, and path().

Referenced by ApiQuerySearch\addInterwikiResults().

◆ addIndexedTagNameRecursive()

ApiResult::addIndexedTagNameRecursive (   $path,
  $tag 
)

Set indexed tag name on $path and all subarrays.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string$tagTag name

Definition at line 660 of file ApiResult.php.

References $path, and path().

◆ addMetadataToResultVars()

static ApiResult::addMetadataToResultVars (   $vars,
  $forceHash = true 
)
static

Add the correct metadata to an array of vars we want to export through the API.

Parameters
array$vars
bool$forceHash
Returns
array

Definition at line 1150 of file ApiResult.php.

References $keys, $vars, and as.

Referenced by ApiExpandTemplates\execute(), ApiParse\execute(), ApiQuerySearch\getSearchResultData(), and ApiResultTest\testAddMetadataToResultVars().

◆ addParsedLimit()

ApiResult::addParsedLimit (   $moduleName,
  $limit 
)

Add the numeric limit for a limit=max to the result.

Since
1.25
Parameters
string$moduleName
int$limit

Definition at line 511 of file ApiResult.php.

References addValue().

◆ addPreserveKeysList()

ApiResult::addPreserveKeysList (   $path,
  $names 
)

Preserve specified keys.

Since
1.25
See also
self::setPreserveKeysList()
Parameters
array | string | null$pathSee ApiResult::addValue()
array | string$namesThe element name(s) to preserve

Definition at line 690 of file ApiResult.php.

References $path, and path().

◆ addSubelementsList()

ApiResult::addSubelementsList (   $path,
  $names 
)

Causes the elements with the specified names to be output as subelements rather than attributes.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
array | string | int$namesThe element name(s) to be output as subelements

Definition at line 580 of file ApiResult.php.

References $path, and path().

◆ addValue()

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.

Parameters
array | string | int | null$path
string | int | null$nameSee ApiResult::setValue()
mixed$value
int$flagsZero 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.
Returns
bool True if $value fits in the result, false if not
Since
1.21 int $flags replaced boolean $override

Definition at line 405 of file ApiResult.php.

References $name, $path, $value, Message\numParam(), path(), and size().

Referenced by addContentValue(), ApiQuerySearch\addInterwikiResults(), addParsedLimit(), MWDebug\appendDebugInfoToApiResult(), and ApiContinuationManager\setContinuationIntoResult().

◆ applyTransformations()

static ApiResult::applyTransformations ( array  $dataIn,
array  $transforms 
)
staticprotected

Apply transformations to an array, returning the transformed array.

See also
ApiResult::getResultData()
Since
1.25
Parameters
array$dataIn
array$transforms
Returns
array|object

Definition at line 806 of file ApiResult.php.

References $data, $keys, $ret, $type, as, null, and object.

◆ formatExpiry()

static ApiResult::formatExpiry (   $expiry,
  $infinity = 'infinity' 
)
static

Format an expiry timestamp for API output.

Since
1.29
Parameters
string$expiryExpiry timestamp, likely from the database
string$infinityUse this string for infinite expiry (only use this to maintain backward compatibility with existing output)
Returns
string Formatted expiry

Definition at line 1205 of file ApiResult.php.

References DB_REPLICA, null, wfGetDB(), wfIsInfinity(), and wfTimestamp().

Referenced by ApiProtect\execute(), ApiQueryBlocks\execute(), ApiBlock\execute(), ApiQueryUsers\execute(), ApiQueryUserInfo\getCurrentUserInfo(), RightsLogFormatter\getParametersForApi(), ApiQueryInfo\getProtectionInfo(), and ApiQueryProtectedTitles\run().

◆ getResultData()

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'.

  • Boolean-valued items are changed to '' if true or removed if false, unless listed in META_BC_BOOLS. This may be skipped by including 'nobool' in the value array.
  • The tag named by META_CONTENT is renamed to '*', and META_CONTENT is set to '*'. This may be skipped by including 'no*' in the value array.
  • Tags listed in META_BC_SUBELEMENTS will have their values changed to [ '*' => $value ]. This may be skipped by including 'nosub' in the value array.
  • If META_TYPE is 'BCarray', set it to 'default'
  • If META_TYPE is 'BCassoc', set it to 'default'
  • If META_TYPE is 'BCkvp', perform the transformation (even if the Types transformation is not being applied).

Types: (assoc) Apply transformations based on META_TYPE. The values array is an associative array with the following possible keys:

  • AssocAsObject: (bool) If true, return arrays with META_TYPE 'assoc' as objects.
  • ArmorKVP: (string) If provided, transform arrays with META_TYPE 'kvp' and 'BCkvp' into arrays of two-element arrays, something like this: $output = []; foreach ( $input as $key => $value ) { $pair = []; $pair[$META_KVP_KEY_NAME ?: $ArmorKVP_value] = $key; ApiResult::setContentValue( $pair, 'value', $value ); $output[] = $pair; }

Strip: (string) Strips metadata keys from the result.

  • 'all': Strip all metadata, recursively
  • 'base': Strip metadata at the top-level only.
  • 'none': Do not strip metadata.
  • 'bc': Like 'all', but leave certain pre-1.25 keys.
Since
1.25
Parameters
array | string | null$pathPath to fetch, see ApiResult::addValue
array$transformsSee above
Returns
mixed Result data, or null if not found

Definition at line 254 of file ApiResult.php.

References $last, $path, $ret, data, null, and path().

Referenced by ApiErrorFormatter\arrayFromStatus().

◆ getSize()

ApiResult::getSize ( )

Get the size of the result, i.e.

the amount of bytes in it

Returns
int

Definition at line 275 of file ApiResult.php.

References $size.

◆ isMetadataKey()

static ApiResult::isMetadataKey (   $key)
static

Test whether a key should be considered metadata.

Parameters
string$key
Returns
bool

Definition at line 793 of file ApiResult.php.

Referenced by ApiFeedWatchlist\execute(), and ApiFormatXml\recXmlPrint().

◆ path()

& ApiResult::path (   $path,
  $create = 'append' 
)
private

Return a reference to the internal data at $path.

Parameters
array | string | null$path
string$createIf 'append', append empty arrays. If 'prepend', prepend empty arrays. If 'dummy', return a dummy array. Else, raise an error.
Returns
array

Definition at line 1113 of file ApiResult.php.

References $data, $path, $ret, and as.

Referenced by addArrayType(), addArrayTypeRecursive(), addContentField(), addIndexedTagName(), addIndexedTagNameRecursive(), addPreserveKeysList(), addSubelementsList(), addValue(), getResultData(), removePreserveKeysList(), removeSubelementsList(), and removeValue().

◆ removePreserveKeysList()

ApiResult::removePreserveKeysList (   $path,
  $names 
)

Don't preserve specified keys.

Since
1.25
See also
self::setPreserveKeysList()
Parameters
array | string | null$pathSee ApiResult::addValue()
array | string$namesThe element name(s) to not preserve

Definition at line 715 of file ApiResult.php.

References $path, and path().

◆ removeSubelementsList()

ApiResult::removeSubelementsList (   $path,
  $names 
)

Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
array | string | int$namesThe element name(s) to not be output as subelements

Definition at line 605 of file ApiResult.php.

References $path, and path().

◆ removeValue()

ApiResult::removeValue (   $path,
  $name,
  $flags = 0 
)

Remove value from the output data at the given path.

Since
1.25
Parameters
array | string | null$pathSee ApiResult::addValue()
string | int | null$nameIndex to remove at $path. If null, $path itself is removed.
int$flagsFlags used when adding the value
Returns
mixed Old value, or null

Definition at line 453 of file ApiResult.php.

References $name, $path, $ret, null, path(), and size().

◆ reset()

ApiResult::reset ( )

Clear the current result data.

Definition at line 194 of file ApiResult.php.

References data, and size().

Referenced by __construct().

◆ serializeForApiResult()

ApiResult::serializeForApiResult ( )

Allow for adding one ApiResult into another.

Since
1.25
Returns
mixed

Implements ApiSerializable.

Definition at line 182 of file ApiResult.php.

References $data.

◆ setArrayType()

◆ setArrayTypeRecursive()

static ApiResult::setArrayTypeRecursive ( array &  $arr,
  $type,
  $kvpKeyName = null 
)
static

Set the array data type recursively.

Since
1.25
Parameters
array&$arr
string$typeSee ApiResult::META_TYPE
string | null$kvpKeyNameSee ApiResult::META_KVP_KEY_NAME

Definition at line 759 of file ApiResult.php.

References $type, and as.

Referenced by ApiQueryFileRepoInfo\execute(), and ApiResultTest\testMetadata().

◆ setContentField()

static ApiResult::setContentField ( array &  $arr,
  $name,
  $flags = 0 
)
static

Set the name of the content field name (META_CONTENT)

Since
1.25
Parameters
array&$arr
string | int$nameName of the field
int$flagsZero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.

Definition at line 532 of file ApiResult.php.

References $name.

◆ setContentValue()

◆ setErrorFormatter()

ApiResult::setErrorFormatter ( ApiErrorFormatter  $formatter)

Set the error formatter.

Since
1.25
Parameters
ApiErrorFormatter$formatter

Definition at line 173 of file ApiResult.php.

◆ setIndexedTagName()

static ApiResult::setIndexedTagName ( array &  $arr,
  $tag 
)
static

Set the tag name for numeric-keyed values in XML format.

Since
1.25 is static
Parameters
array&$arr
string$tagTag name

Definition at line 616 of file ApiResult.php.

Referenced by ApiQueryBase\addPageSubItems(), ApiQuerySiteinfo\appendDbReplLagInfo(), MWDebug\appendDebugInfoToApiResult(), ApiQuerySiteinfo\appendExtensions(), ApiQuerySiteinfo\appendExtensionTags(), ApiQuerySiteinfo\appendFileExtensions(), ApiQuerySiteinfo\appendFunctionHooks(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQuerySiteinfo\appendInstalledLibraries(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\appendLanguages(), ApiQuerySiteinfo\appendLanguageVariants(), ApiQuerySiteinfo\appendMagicWords(), ApiQuerySiteinfo\appendNamespaceAliases(), ApiQuerySiteinfo\appendNamespaces(), ApiQuerySiteinfo\appendProtocols(), ApiQuerySiteinfo\appendRestrictions(), ApiQuerySiteinfo\appendSkins(), ApiQuerySiteinfo\appendSpecialPageAliases(), ApiQuerySiteinfo\appendSubscribedHooks(), ApiQuerySiteinfo\appendUserGroups(), ApiQuerySiteinfo\appendVariables(), ApiErrorFormatter_BackCompat\arrayFromStatus(), ApiUpload\checkVerification(), ApiProtect\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiWatch\execute(), ApiMove\execute(), ApiRsd\execute(), ApiEditPage\execute(), ApiPurge\execute(), ApiTag\execute(), ApiExpandTemplates\execute(), ApiRevisionDelete\execute(), ApiParamInfo\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryDeletedrevs\execute(), ApiQueryAllUsers\execute(), ApiQueryFileRepoInfo\execute(), ApiUserrights\execute(), ApiQueryLanguageinfo\execute(), ApiQueryUsers\execute(), ApiQueryRevisionsBase\extractAllSlotInfo(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), ApiParamInfo\formatHelpMessages(), ApiAuthManagerHelper\formatMessage(), RightsLogFormatter\formatParametersForApi(), BlockLogFormatter\formatParametersForApi(), DeleteLogFormatter\formatParametersForApi(), LogFormatter\formatParametersForApi(), ApiErrorFormatter\formatRawMessage(), ApiRsd\formatRsdApiList(), ApiPageSet\getConvertedTitlesAsResult(), ApiQueryUserInfo\getCurrentUserInfo(), ApiPageSet\getInterwikiTitlesAsResult(), ApiPageSet\getMissingRevisionIDsAsResult(), ApiParamInfo\getModuleInfo(), ApiPageSet\getNormalizedTitlesAsResult(), ApiPageSet\getRedirectTitlesAsResult(), ApiQueryBlocks\getRestrictionData(), ApiQuery\outputGeneralPageInfo(), ApiOpenSearch\populateResult(), ApiTag\processIndividual(), ApiQueryImageInfo\processMetaData(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryBacklinks\run(), ApiParse\setIndexedTagNames(), LogFormatterTest\testApiParamFormatting(), ApiResultTest\testMetadata(), and ApiUpload\transformWarnings().

◆ setIndexedTagNameRecursive()

static ApiResult::setIndexedTagNameRecursive ( array &  $arr,
  $tag 
)
static

Set indexed tag name on $arr and all subarrays.

Since
1.25
Parameters
array&$arr
string$tagTag name

Definition at line 641 of file ApiResult.php.

References as.

Referenced by ApiParse\formatLimitReportData(), and ApiResultTest\testMetadata().

◆ setPreserveKeysList()

static ApiResult::setPreserveKeysList ( array &  $arr,
  $names 
)
static

Preserve specified keys.

This prevents XML name mangling and preventing keys from being removed by self::stripMetadata().

Since
1.25
Parameters
array&$arr
array | string$namesThe element name(s) to preserve

Definition at line 675 of file ApiResult.php.

Referenced by FormatMetadata\sanitizeArrayForAPI(), and ApiResultTest\testMetadata().

◆ setSubelementsList()

static ApiResult::setSubelementsList ( array &  $arr,
  $names 
)
static

Causes the elements with the specified names to be output as subelements rather than attributes.

Since
1.25 is static
Parameters
array&$arr
array | string | int$namesThe element name(s) to be output as subelements

Definition at line 565 of file ApiResult.php.

Referenced by ApiRsd\execute(), ApiHelp\execute(), ApiExpandTemplates\execute(), ApiRsd\formatRsdApiList(), ApiParamInfo\getModuleInfo(), ApiOpenSearch\populateResult(), and ApiResultTest\testMetadata().

◆ setValue()

static ApiResult::setValue ( array &  $arr,
  $name,
  $value,
  $flags = 0 
)
static

Add an output value to the array by name.

Verifies that value with the same name has not been added before.

Since
1.25
Parameters
array&$arrTo add $value to
string | int | null$nameIndex of $arr to add $value at, or null to use the next numeric index.
mixed$value
int$flagsZero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.

Definition at line 291 of file ApiResult.php.

References $keys, $name, $value, and null.

Referenced by ApiResultTest\testObjectSerialization(), and ApiResultTest\testStaticDataMethods().

◆ size()

static ApiResult::size (   $value)
staticprivate

Get the 'real' size of a result item.

This means the strlen() of the item, or the sum of the strlen()s of the elements if the item is an array.

Parameters
mixed$valueValidated value (see self::validateValue())
Returns
int

Definition at line 1087 of file ApiResult.php.

References $s, $value, and as.

Referenced by addValue(), removeValue(), and reset().

◆ stripMetadata()

static ApiResult::stripMetadata (   $data)
static

Recursively remove metadata keys from a data array or object.

Note this removes all potential metadata keys, not just the defined ones.

Since
1.25
Parameters
array | object$data
Returns
array|object

Definition at line 1022 of file ApiResult.php.

References $data, as, and object.

Referenced by ApiResultTest\testUtilityFunctions().

◆ stripMetadataNonRecursive()

static ApiResult::stripMetadataNonRecursive (   $data,
$metadata = null 
)
static

Remove metadata keys from a data array or object, non-recursive.

Note this removes all potential metadata keys, not just the defined ones.

Since
1.25
Parameters
array | object$data
array | null&$metadataStore metadata here, if provided
Returns
array|object

Definition at line 1056 of file ApiResult.php.

References $data, as, and object.

Referenced by ApiQuery\outputGeneralPageInfo(), and ApiResultTest\testUtilityFunctions().

◆ unsetPreserveKeysList()

static ApiResult::unsetPreserveKeysList ( array &  $arr,
  $names 
)
static

Don't preserve specified keys.

Since
1.25
See also
self::setPreserveKeysList()
Parameters
array&$arr
array | string$namesThe element name(s) to not preserve

Definition at line 702 of file ApiResult.php.

Referenced by ApiResultTest\testMetadata().

◆ unsetSubelementsList()

static ApiResult::unsetSubelementsList ( array &  $arr,
  $names 
)
static

Causes the elements with the specified names to be output as attributes (when possible) rather than as subelements.

Since
1.25
Parameters
array&$arr
array | string | int$namesThe element name(s) to not be output as subelements

Definition at line 592 of file ApiResult.php.

Referenced by ApiResultTest\testMetadata().

◆ unsetValue()

static ApiResult::unsetValue ( array &  $arr,
  $name 
)
static

Remove an output value to the array by name.

Parameters
array&$arrTo remove $value from
string | int$nameIndex of $arr to remove
Returns
mixed Old value, or null

Definition at line 434 of file ApiResult.php.

References $name, $ret, and null.

Referenced by ApiResultTest\testStaticDataMethods().

◆ validateValue()

static ApiResult::validateValue (   $value)
staticprivate

Validate a value for addition to the result.

Parameters
mixed$value
Returns
array|mixed|string

Definition at line 334 of file ApiResult.php.

References $type, $value, as, null, and string.

Member Data Documentation

◆ $checkingSize

ApiResult::$checkingSize
private

Definition at line 149 of file ApiResult.php.

◆ $data

ApiResult::$data
private

◆ $errorFormatter

ApiResult::$errorFormatter
private

Definition at line 146 of file ApiResult.php.

◆ $mainForContinuation

ApiResult::$mainForContinuation

Definition at line 149 of file ApiResult.php.

◆ $maxSize

ApiResult::$maxSize

Definition at line 145 of file ApiResult.php.

Referenced by __construct().

◆ $size

ApiResult::$size

Definition at line 145 of file ApiResult.php.

Referenced by getSize().

◆ ADD_ON_TOP

const 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.

Since
1.21

Definition at line 49 of file ApiResult.php.

Referenced by ApiErrorFormatter_BackCompat\addWarningOrError(), ApiErrorFormatter\addWarningOrError(), ApiQuery\execute(), ApiContinuationManager\setContinuationIntoResult(), ApiResultTest\testInstanceDataMethods(), and ApiResultTest\testStaticDataMethods().

◆ META_BC_BOOLS

◆ META_BC_SUBELEMENTS

const ApiResult::META_BC_SUBELEMENTS = '_BC_subelements'

◆ META_CONTENT

◆ META_INDEXED_TAG_NAME

◆ META_KVP_KEY_NAME

const 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.

Since
1.25

Definition at line 119 of file ApiResult.php.

Referenced by ApiFormatNoneTest\provideGeneralEncoding(), ApiFormatPhpTest\provideGeneralEncoding(), ApiFormatXmlTest\provideGeneralEncoding(), ApiFormatJsonTest\provideGeneralEncoding(), ApiResultTest\provideTransformations(), ApiResultTest\testAddMetadataToResultVars(), and ApiResultTest\testMetadata().

◆ META_KVP_MERGE

const 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.

Since
1.26

Definition at line 129 of file ApiResult.php.

Referenced by ApiQueryRevisionsBase\extractAllSlotInfo(), and ApiResultTest\provideTransformations().

◆ META_PRESERVE_KEYS

const ApiResult::META_PRESERVE_KEYS = '_preservekeys'

◆ META_SUBELEMENTS

const ApiResult::META_SUBELEMENTS = '_subelements'

◆ META_TYPE

const ApiResult::META_TYPE = '_type'

Key for the 'type' metadata item.

Value is one of the following strings:

  • default: Like 'array' if all (non-metadata) keys are numeric with no gaps, otherwise like 'assoc'.
  • array: Keys are used for ordering, but are not output. In a format like JSON, outputs as [].
  • assoc: In a format like JSON, outputs as {}.
  • kvp: For a format like XML where object keys have a restricted character set, use an alternative output format. For example, <container>value</container> rather than <container key="value">
  • BCarray: Like 'array' normally, 'default' in backwards-compatibility mode.
  • BCassoc: Like 'assoc' normally, 'default' in backwards-compatibility mode.
  • BCkvp: Like 'kvp' normally. In backwards-compatibility mode, forces the alternative output format for all formats, for example [{"name":key,"*":value}] in JSON. META_KVP_KEY_NAME must also be set.
    Since
    1.25

Definition at line 110 of file ApiResult.php.

Referenced by ApiQuerySiteinfo\appendNamespaces(), ApiResultTest\customTransform(), ApiTokens\execute(), ApiQueryTokens\execute(), ApiQueryBlocks\execute(), ApiFormatXml\execute(), ApiQueryLogEvents\extractRowInfo(), ApiErrorFormatter\formatMessageInternal(), ApiAuthManagerHelper\formatRequests(), ApiQueryImageInfo\getInfo(), ApiQueryUserInfo\getRateLimits(), LogFormatterTest\provideApiParamFormatting(), ApiErrorFormatterTest\provideErrorFormatter(), ApiFormatNoneTest\provideGeneralEncoding(), ApiFormatPhpTest\provideGeneralEncoding(), ApiFormatXmlTest\provideGeneralEncoding(), ApiFormatJsonTest\provideGeneralEncoding(), ApiResultTest\provideTransformations(), ApiFormatXml\recXmlPrint(), ApiQueryExtLinksUsage\run(), ApiQueryPagesWithProp\run(), ApiQueryCategoryMembers\run(), ApiQueryAllLinks\run(), ApiErrorFormatterTest\testAddMessagesFromStatus_filter(), ApiResultTest\testAddMetadataToResultVars(), ApiErrorFormatterTest\testErrorFormatter(), ApiErrorFormatterTest\testErrorFormatterBasics(), ApiErrorFormatterTest\testErrorFormatterBC(), ApiResultTest\testInstanceDataMethods(), ApiResultTest\testMetadata(), ApiResultTest\testObjectSerialization(), ApiResultTest\testStaticDataMethods(), and ApiResultTest\testUtilityFunctions().

◆ NO_SIZE_CHECK

const 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.

Since
1.24

Definition at line 58 of file ApiResult.php.

Referenced by ApiMain\addRequestedFields(), ApiErrorFormatter_BackCompat\addWarningOrError(), ApiErrorFormatter\addWarningOrError(), ApiQuery\doExport(), ApiHelp\execute(), ApiFormatXml\execute(), ApiComparePages\execute(), ApiQuery\execute(), ApiContinuationManager\setContinuationIntoResult(), ApiMain\substituteResultWithError(), ApiResultTest\testInstanceDataMethods(), and ApiResultTest\testStaticDataMethods().

◆ NO_VALIDATE

const 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.

Since
1.25

Definition at line 66 of file ApiResult.php.

Referenced by ApiFormatJsonTest\provideGeneralEncoding(), ApiFormatFeedWrapper\setResult(), ApiResultTest\testInstanceDataMethods(), and ApiResultTest\testStaticDataMethods().

◆ OVERRIDE

const ApiResult::OVERRIDE = 1

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