MediaWiki  master
ApiMessageTrait.php File Reference

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

Go to the source code of this file.

Functions

 getApiCode ()
 
 getApiData ()
 
 serialize ()
 
 setApiCode ( $code, array $data=null)
 
 setApiData (array $data)
 
 unserialize ( $serialized)
 

Variables

trait $apiCode = null
 
 $apiData = []
 
trait ApiMessageTrait
 Trait to implement the IApiMessage interface for Message subclasses. More...
 

Detailed Description

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 ApiMessageTrait.php.

Function Documentation

◆ getApiCode()

getApiCode ( )

Definition at line 93 of file ApiMessageTrait.php.

References $apiCode, and null.

◆ getApiData()

getApiData ( )

Definition at line 126 of file ApiMessageTrait.php.

References $apiData.

◆ serialize()

serialize ( )

Definition at line 134 of file ApiMessageTrait.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(), ContentHandlerTest\dataMakeContent(), JobQueueMemory\doBatchPush(), MediaWikiTestCase\doStashMwGlobals(), MultiWriteBagOStuff\doWrite(), LCStoreStaticArray\encode(), ApiFormatPhp\execute(), DumpMessages\execute(), PPFuzzTester\execute(), ChangesFeed\execute(), GetConfiguration\execute(), AuthManagerSpecialPage\fieldInfoToFormDescriptor(), MemcachedClient\get(), JobQueueFederated\getCoalesceLocationInternal(), WebInstaller\getFingerprint(), MachineReadableRCFeedFormatter\getLine(), GIFHandler\getMetadata(), PNGHandler\getMetadata(), WebPHandler\getMetadata(), TiffHandler\getMetadata(), JpegHandler\getMetadata(), XCFHandler\getMetadata(), ForeignAPIFile\getMetadata(), DjVuHandler\getMetadata(), SvgHandler\getMetadata(), MediaWiki\Session\Session\getSecret(), ParserFuzzTest\guessVarSize(), Wikimedia\Rdbms\DatabaseMssql\insert(), JobQueueDB\insertFields(), MediaWiki\Tests\Maintenance\DeleteAutoPatrolLogsTest\insertLoggingData(), MemoizedCallable\invokeArgs(), LocalFile\isCacheable(), DjVuHandler\isMetadataValid(), MessageCache\loadFromDB(), ProfilerOutputDump\log(), JobQueueDB\makeBlob(), LogEntryBase\makeParamBlob(), RecentChange\newForCategorization(), MediaWikiTestCase\objectAssociativeSort(), MediaWiki\Tests\Storage\SqlBlobStoreTest\provideDecompress(), RevisionTest\provideDecompressRevisionText(), RevisionDbTestBase\provideGetContent(), RevisionDbTestBase\provideGetContentFormat(), RevisionDbTestBase\provideGetContentHandler(), RevisionDbTestBase\provideGetContentModel(), RevisionDbTestBase\provideGetSha1(), RevisionDbTestBase\provideGetSize(), XCFHandlerTest\provideIsMetadataValid(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\provideNewMutableRevisionFromArray(), LocalisationCacheBulkLoad\readPHPFile(), MessageCache\refreshAndReplaceInternal(), MediaWiki\Session\SessionBackend\save(), DBSiteStore\saveSites(), WinCacheBagOStuff\set(), LCStoreDB\set(), LCStoreCDB\set(), RESTBagOStuff\set(), MediaWiki\Session\Session\setSecret(), APCBagOStuff\setSerialize(), ParserTestRunner\setupUploads(), RedisConnectionPool\singleton(), UploadStash\stashFile(), ApiMessageTest\testApiMessage(), ApiMessageTest\testApiRawMessage(), EditPageTest\testCheckDirectEditingDisallowed_forNonTextContent(), SvgHandlerTest\testGetAvailableLanguages(), HashRingTest\testHashRingSerialize(), SvgHandlerTest\testNormaliseParamsInternal(), RecentChangeTest\testParseParams(), SiteListTest\testSerialization(), GenericArrayObjectTest\testSerialization(), SiteTest\testSerialization(), MessageTest\testSerialization(), MediaWiki\Tests\Revision\testSerialization_fails(), MapCacheLRUTest\testSerialize(), DatabaseMysqlBaseTest\testSerialize(), ApiEditPageTest\testSupportsDirectApiEditing_withContentHandlerOverride(), and JobQueueFederated\tryJobInsertions().

◆ setApiCode()

setApiCode (   $code,
array  $data = null 
)

Definition at line 115 of file ApiMessageTrait.php.

References $code, ApiErrorFormatter\isValidApiCode(), null, and setApiData().

◆ setApiData()

setApiData ( array  $data)

Definition at line 130 of file ApiMessageTrait.php.

Referenced by setApiCode().

◆ unserialize()

unserialize (   $serialized)

Definition at line 142 of file ApiMessageTrait.php.

References $serialized.

Referenced by DiffHistoryBlob\__wakeup(), MemcachedClient\_load_items(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), XCFHandler\canRender(), CheckStorage\check(), ExifBitmapHandler\convertMetadataVersion(), MediaHandler\convertMetadataVersion(), File\convertMetadataVersion(), LCStoreStaticArray\decode(), MediaWiki\Storage\SqlBlobStore\decompressData(), WinCacheBagOStuff\doGet(), RESTBagOStuff\doGet(), MediaWikiTestCase\doStashMwGlobals(), MultiWriteBagOStuff\doWrite(), ApiQueryFilearchive\execute(), FixT22757\execute(), JobQueueDB\extractBlob(), LogEntryBase\extractParams(), ExternalStoreDB\fetchBlob(), 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(), PPFuzzUser\getOption(), ExifBitmapHandler\getRotationForExif(), MediaWiki\Session\Session\getSecret(), SiteImporterTest\getSerializedSiteList(), SitesCacheFileBuilder\getSiteAsArray(), HistoryBlobStub\getText(), APCBagOStuff\getUnserialize(), DjVuHandler\getUnserializedMetadata(), 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(), ApiMessageTest\testApiMessage(), ApiMessageTest\testApiRawMessage(), GIFHandlerTest\testGetMetadata(), HashRingTest\testHashRingSerialize(), JpegTest\testJpegMetadataExtraction(), SiteListTest\testSerialization(), GenericArrayObjectTest\testSerialization(), SiteTest\testSerialization(), MessageTest\testSerialization(), MapCacheLRUTest\testSerialize(), DatabaseMysqlBaseTest\testSerialize(), TiffTest\testTiffMetadataExtraction(), AutoLoaderTest\testWrongCaseSerializedClass(), BitmapHandler\transformImageMagick(), ConcatenatedGzipHistoryBlob\uncompress(), SvgHandler\unpackMetadata(), SiteList\unserialize(), DummyNonTextContentHandler\unserializeContent(), DummyContentHandlerForTesting\unserializeContent(), and wfGetPrecompiledData().

Variable Documentation

◆ $apiCode

trait $apiCode = null
protected

Definition at line 90 of file ApiMessageTrait.php.

Referenced by getApiCode().

◆ $apiData

$apiData = []
protected

Definition at line 91 of file ApiMessageTrait.php.

Referenced by getApiData().