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

 $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 97 of file ApiMessageTrait.php.

References $apiCode.

◆ getApiData()

getApiData ( )

Definition at line 130 of file ApiMessageTrait.php.

References $apiData.

◆ serialize()

serialize ( )

Definition at line 138 of file ApiMessageTrait.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), DiffHistoryBlob\__sleep(), MultiWriteBagOStuff\callKeyWriteMethodOnTierCaches(), CgzCopyTransaction\commit(), ResourceLoaderFileModule\compileLessString(), ConcatenatedGzipHistoryBlob\compress(), CompressOld\compressWithConcat(), JobQueueMemory\doBatchPush(), LCStoreStaticArray\encode(), ApiFormatPhp\execute(), GetConfiguration\execute(), DumpMessages\execute(), PPFuzzTester\execute(), AuthManagerSpecialPage\fieldInfoToFormDescriptor(), JobQueueFederated\getCoalesceLocationInternal(), WebInstaller\getFingerprint(), MachineReadableRCFeedFormatter\getLine(), ForeignAPIFile\getMetadata(), LocalFile\getMetadata(), UnregisteredLocalFile\getMetadata(), LocalFile\getMetadataForDb(), MediaWiki\Session\Session\getSecret(), MediumSpecificBagOStuff\getSerialized(), JobQueueDB\insertFields(), MemoizedCallable\invokeArgs(), LocalFile\isCacheable(), LocalFile\loadFromCache(), MessageCache\loadFromDB(), ProfilerOutputDump\log(), JobQueueDB\makeBlob(), LogEntryBase\makeParamBlob(), RecentChange\newForCategorization(), LocalisationCacheBulkLoad\readPHPFile(), MessageCache\refreshAndReplaceInternal(), MediaWiki\Session\SessionBackend\save(), DBSiteStore\saveSites(), MediumSpecificBagOStuff\serialize(), LCStoreCDB\set(), LCStoreDB\set(), MediumSpecificBagOStuff\setNewPreparedValues(), MediaWiki\Session\Session\setSecret(), RedisConnectionPool\singleton(), UploadStash\stashFile(), and JobQueueFederated\tryJobInsertions().

◆ setApiCode()

setApiCode (   $code,
array  $data = null 
)

Definition at line 119 of file ApiMessageTrait.php.

References ApiErrorFormatter\isValidApiCode(), and setApiData().

◆ setApiData()

setApiData ( array  $data)

Definition at line 134 of file ApiMessageTrait.php.

Referenced by setApiCode().

◆ unserialize()

Variable Documentation

◆ $apiCode

$apiCode = null
protected

Definition at line 94 of file ApiMessageTrait.php.

Referenced by getApiCode().

◆ $apiData

$apiData = []
protected

Definition at line 95 of file ApiMessageTrait.php.

Referenced by getApiData().