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

Functions
	__serialize ()

	__unserialize ( $data)

	getApiCode ()

	getApiData ()

	setApiCode ( $code, array $data=null)

	setApiData (array $data)

Variables
string null	$apiCode = null

array	$apiData = []

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

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

◆ __serialize()

__serialize ( )

Definition at line 143 of file ApiMessageTrait.php.

References $apiCode, and $apiData.

◆ __unserialize()

__unserialize ( $data )

Definition at line 151 of file ApiMessageTrait.php.

◆ getApiCode()

getApiCode ( )

Definition at line 102 of file ApiMessageTrait.php.

References $apiCode.

◆ getApiData()

getApiData ( )

Definition at line 135 of file ApiMessageTrait.php.

References $apiData.

◆ setApiCode()

setApiCode	(		$code,
		array	$data = null )

Definition at line 124 of file ApiMessageTrait.php.

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

Referenced by ApiMessage\__construct().

◆ setApiData()

setApiData ( array $data )

Definition at line 139 of file ApiMessageTrait.php.

Referenced by setApiCode().

Variable Documentation

◆ $apiCode

string null $apiCode = null

protected

Definition at line 98 of file ApiMessageTrait.php.

Referenced by __serialize(), getApiCode(), and ApiRawMessage\getApiCode().

◆ $apiData

array $apiData = []