Defines an interface for messages with additional machine-readable data for use by the API, and provides concrete implementations of that interface. More...

Classes
class	ApiMessage
	Extension of Message implementing IApiMessage. More...

class	ApiRawMessage
	Extension of RawMessage implementing IApiMessage. More...

interface	IApiMessage
	Interface for messages with machine-readable data for use by the API. More...

Functions
	getApiCode ()

	getApiData ()

	serialize ()

	setApiCode ( $code, array $data=null)

	setApiData (array $data)

	unserialize ( $serialized)

Variables
	$apiCode = null

	$apiData = []

trait	ApiMessageTrait
	Trait to implement the IApiMessage interface for Message subclasses. More...

Detailed Description

Defines an interface for messages with additional machine-readable data for use by the API, and provides concrete implementations of that interface.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file ApiMessage.php.

Function Documentation

◆ getApiCode()

getApiCode ( )

Definition at line 139 of file ApiMessage.php.

References $apiCode.

◆ getApiData()

getApiData ( )

Definition at line 169 of file ApiMessage.php.

References $apiData.

◆ serialize()

serialize ( )

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 177 of file ApiMessage.php.

Referenced by Wikimedia\Rdbms\MssqlBlob\__construct(), MemcachedPeclBagOStuff\__construct(), MediaWiki\Session\SessionBackend\__construct(), DiffHistoryBlob\__sleep(), MemcachedClient\_set(), ORAResult\array_unique_md(), CgzCopyTransaction\commit(), ResourceLoaderFileModule\compileLessFile(), ConcatenatedGzipHistoryBlob\compress(), CompressOld\compressWithConcat(), UpdateLogging\copyExactMatch(), RevisionTest\dataGetContent(), RevisionTest\dataGetContentFormat(), RevisionTest\dataGetContentHandler(), RevisionTest\dataGetContentModel(), RevisionTest\dataGetSha1(), RevisionTest\dataGetSize(), ContentHandlerTest\dataMakeContent(), JobQueueMemory\doBatchPush(), LCStoreStaticArray\encode(), ApiFormatPhp\execute(), DumpMessages\execute(), GenerateNormalizerDataMl\execute(), GenerateNormalizerDataAr\execute(), PPFuzzTester\execute(), ChangesFeed\execute(), GetConfiguration\execute(), AuthManagerSpecialPage\fieldInfoToFormDescriptor(), GenerateCollationData\generateFirstChars(), MemcachedClient\get(), JobQueueFederated\getCoalesceLocationInternal(), WebInstaller\getFingerprint(), MachineReadableRCFeedFormatter\getLine(), GIFHandler\getMetadata(), PNGHandler\getMetadata(), WebPHandler\getMetadata(), TiffHandler\getMetadata(), JpegHandler\getMetadata(), XCFHandler\getMetadata(), ForeignAPIFile\getMetadata(), PdfHandler\getMetadata(), DjVuHandler\getMetadata(), SvgHandler\getMetadata(), MediaWiki\Tidy\BalanceElement\getNoahKey(), MediaWiki\Session\Session\getSecret(), ParserFuzzTest\guessVarSize(), WikiRevision\importOldRevision(), CryptRand\initialRandomState(), Wikimedia\Rdbms\DatabaseMssql\insert(), JobQueueDB\insertFields(), MemoizedCallable\invokeArgs(), LocalFile\isCacheable(), PdfHandler\isMetadataValid(), DjVuHandler\isMetadataValid(), MessageCache\loadFromDB(), ProfilerOutputDump\log(), JobQueueDB\makeBlob(), LogEntryBase\makeParamBlob(), RecentChange\newForCategorization(), MediaWikiTestCase\objectAssociativeSort(), XCFHandlerTest\provideIsMetadataValid(), LocalisationCacheBulkLoad\readPHPFile(), MediaWiki\Session\SessionBackend\save(), DBSiteStore\saveSites(), WinCacheBagOStuff\set(), XCacheBagOStuff\set(), LCStoreDB\set(), RESTBagOStuff\set(), LCStoreCDB\set(), MediaWiki\Session\Session\setSecret(), APCBagOStuff\setSerialize(), RedisConnectionPool\singleton(), UploadStash\stashFile(), MediaWikiTestCase\stashMwGlobals(), ApiMessageTest\testApiMessage(), ApiMessageTest\testApiRawMessage(), EditPageTest\testCheckDirectEditingDisallowed_forNonTextContent(), RecentChangeTest\testParseParams(), SiteListTest\testSerialization(), GenericArrayObjectTest\testSerialization(), SiteTest\testSerialization(), ApiEditPageTest\testSupportsDirectApiEditing_withContentHandlerOverride(), and JobQueueFederated\tryJobInsertions().

◆ setApiCode()

setApiCode	(		$code,
		array	$data = `null`
	)

Definition at line 158 of file ApiMessage.php.

References $code, and setApiData().

◆ setApiData()

setApiData ( array $data )

Definition at line 173 of file ApiMessage.php.

Referenced by setApiCode().

◆ unserialize()

unserialize ( $serialized )

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 185 of file ApiMessage.php.

References $serialized.

Referenced by DiffHistoryBlob\__wakeup(), MemcachedClient\_load_items(), BackupDumperLoggerTest\assertLogItem(), XCFHandler\canRender(), CheckStorage\check(), ExifBitmapHandler\convertMetadataVersion(), MediaHandler\convertMetadataVersion(), File\convertMetadataVersion(), LCStoreStaticArray\decode(), Revision\decompressRevisionText(), WinCacheBagOStuff\doGet(), XCacheBagOStuff\doGet(), RESTBagOStuff\doGet(), DumpRev\execute(), ApiQueryFilearchive\execute(), FixT22757\execute(), JobQueueDB\extractBlob(), LogEntryBase\extractParams(), ExternalStoreDB\fetchBlob(), PdfHandler\formatMetadata(), LCStoreDB\get(), LCStoreCDB\get(), GIFHandler\getCommonMetaArray(), PNGHandler\getCommonMetaArray(), ExifBitmapHandler\getCommonMetaArray(), SiteConfiguration\getConfig(), UploadStash\getFile(), GIFHandler\getImageArea(), WebPHandler\getImageSize(), ApiQueryImageInfo\getInfo(), JobQueueDB\getJobIterator(), PNGHandler\getLength(), GIFHandler\getLength(), PNGHandler\getLongDesc(), GIFHandler\getLongDesc(), PdfHandler\getMetaArray(), ExifBitmapHandler\getRotationForExif(), MediaWiki\Session\Session\getSecret(), SiteImporterTest\getSerializedSiteList(), SitesCacheFileBuilder\getSiteAsArray(), HistoryBlobStub\getText(), APCBagOStuff\getUnserialize(), DjVuHandler\getUnserializedMetadata(), CreatePdfThumbnailsJob\insertJobs(), PNGHandler\isAnimatedImage(), GIFHandler\isAnimatedImage(), WebPHandler\isAnimatedImage(), WebPHandler\isMetadataValid(), ExifBitmapHandler\isMetadataValid(), PNGHandler\isMetadataValid(), GIFHandler\isMetadataValid(), FixT22757\isUnbrokenStub(), DBSiteStore\loadSites(), ExternalStoreDB\mergeBatchResult(), moveToExternal(), RecentChange\parseParams(), PurgeChangedFiles\purgeFromLogType(), LocalisationCacheBulkLoad\readPHPFile(), resolveStub(), MediaWikiTestCase\stashMwGlobals(), ApiMessageTest\testApiMessage(), ApiMessageTest\testApiRawMessage(), GIFHandlerTest\testGetMetadata(), JpegTest\testJpegMetadataExtraction(), SiteListTest\testSerialization(), GenericArrayObjectTest\testSerialization(), SiteTest\testSerialization(), TiffTest\testTiffMetadataExtraction(), AutoLoaderTest\testWrongCaseSerializedClass(), BitmapHandler\transformImageMagick(), ConcatenatedGzipHistoryBlob\uncompress(), SvgHandler\unpackMetadata(), SiteList\unserialize(), DummyNonTextContentHandler\unserializeContent(), and DummyContentHandlerForTesting\unserializeContent().

Variable Documentation

◆ $apiCode

$apiCode = null

protected

Definition at line 136 of file ApiMessage.php.

Referenced by getApiCode().

◆ $apiData

$apiData = []