Inheritance diagram for Response:

Public Member Functions
	setMimeType ($mimeType)

	addMessage ($message, $code, $params=[], $type=self::MESSAGE_TYPE_ERROR)

	hasMessages ()

	getMessages ()

	clearMessages ()

Public Member Functions inherited from Response
	getHeader ($name)

	sendResponse ()

	appendBody ($value)

	setBody ($value)

	clearBody ()

	setHeader ($name, $value, $replace=false)

	clearHeader ($name)

	clearHeaders ()

	setRedirect ($url, $code=302)

	setHttpResponseCode ($code)

	setStatusHeader ($httpCode, $version=null, $phrase=null)

	getHttpResponseCode ()

	isRedirect ()

	__sleep ()

Data Fields
const	RESPONSE_CHARSET = 'utf-8'

const	MESSAGE_TYPE_SUCCESS = 'success'

const	MESSAGE_TYPE_ERROR = 'error'

const	MESSAGE_TYPE_WARNING = 'warning'

const	HTTP_OK = 200

Protected Attributes
	$_messages = []

Protected Attributes inherited from Response
	$isRedirect = false

Detailed Description

Definition at line 10 of file Response.php.

Member Function Documentation

◆ addMessage()

addMessage	(	$message,
		$code,
		$params = `[]`,
		$type = `self::MESSAGE_TYPE_ERROR`
	)

Add message to response.

Parameters

string	$message
string	$code
array	$params
string	$type

Returns: $this

Definition at line 59 of file Response.php.

     {
         $params['message'] = $message;
         $params['code'] = $code;
         $this->_messages[$type][] = $params;
         return $this;
     }

◆ clearMessages()

clearMessages ( )

Clear messages.

Returns: $this

Definition at line 92 of file Response.php.

     {
         $this->_messages = [];
         return $this;
     }

◆ getMessages()

getMessages ( )

Return messages.

Returns: array

Definition at line 82 of file Response.php.

     {
         return $this->_messages;
     }

◆ hasMessages()

hasMessages ( )

Has messages.

Returns: bool

Definition at line 72 of file Response.php.

     {
         return (bool)count($this->_messages) > 0;
     }

◆ setMimeType()

setMimeType ( $mimeType )

Set header appropriate to specified MIME type.

Parameters

string $mimeType MIME type

Returns: $this

Definition at line 45 of file Response.php.

     {
         return $this->setHeader('Content-Type', "{$mimeType}; charset=" . self::RESPONSE_CHARSET, true);
     }

Field Documentation

◆ $_messages

$_messages = []

protected

#- #-

Definition at line 37 of file Response.php.

◆ HTTP_OK

const HTTP_OK = 200

#- #+ Success HTTP response codes.

Definition at line 32 of file Response.php.

◆ MESSAGE_TYPE_ERROR

const MESSAGE_TYPE_ERROR = 'error'

Definition at line 23 of file Response.php.

◆ MESSAGE_TYPE_SUCCESS

const MESSAGE_TYPE_SUCCESS = 'success'

#+ Default message types.

Definition at line 21 of file Response.php.

◆ MESSAGE_TYPE_WARNING

const MESSAGE_TYPE_WARNING = 'warning'

Definition at line 25 of file Response.php.

◆ RESPONSE_CHARSET

const RESPONSE_CHARSET = 'utf-8'

Character set which must be used in response.

Definition at line 16 of file Response.php.

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

vendor/magento/framework/Webapi/Response.php

Public Member Functions

Data Fields

Protected Attributes