owncloud/core

View on GitHub
lib/public/AppFramework/Http/DataDisplayResponse.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Roeland Jago Douma <rullzer@owncloud.com>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCP\AppFramework\Http;

use OCP\AppFramework\Http;

/**
 * Class DataDisplayResponse
 *
 * @package OCP\AppFramework\Http
 * @since 8.1.0
 */
class DataDisplayResponse extends Response {
    /**
     * response data
     * @var string;
     */
    protected $data;

    /**
     * @param string $data the data to display
     * @param int $statusCode the Http status code, defaults to 200
     * @param array $headers additional key value based headers
     * @since 8.1.0
     */
    public function __construct(
        $data="",
        $statusCode=Http::STATUS_OK,
        $headers=[]
    ) {
        $this->data = $data;
        $this->setStatus($statusCode);
        $this->setHeaders(\array_merge($this->getHeaders(), $headers));
        $this->addHeader('Content-Disposition', 'inline; filename=""');
    }

    /**
     * Outputs data. No processing is done.
     * @return string
     * @since 8.1.0
     */
    public function render() {
        return $this->data;
    }

    /**
     * Sets values in the data
     * @param string $data the data to display
     * @return DataDisplayResponse Reference to this object
     * @since 8.1.0
     */
    public function setData($data) {
        $this->data = $data;

        return $this;
    }

    /**
     * Used to get the set parameters
     * @return string the data
     * @since 8.1.0
     */
    public function getData() {
        return $this->data;
    }
}