Response.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Webapi;

class Response extends \Magento\Framework\HTTP\PhpEnvironment\Response implements
    \Magento\Framework\App\Response\HttpInterface
{
    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 $_messages = [];

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

    public function addMessage($message, $code, $params = [], $type = self::MESSAGE_TYPE_ERROR)
    {
        $params['message'] = $message;
        $params['code'] = $code;
        $this->_messages[$type][] = $params;
        return $this;
    }

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

    public function getMessages()
    {
        return $this->_messages;
    }

    public function clearMessages()
    {
        $this->_messages = [];
        return $this;
    }
}