nextcloud/lib/public/response.php

100 lines
2.8 KiB
PHP
Raw Normal View History

2012-05-03 12:46:27 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
2012-05-03 12:46:27 +04:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* Response Class.
*
*/
2012-08-29 10:38:33 +04:00
// use OCP namespace for all classes that are considered public.
2012-05-03 12:46:27 +04:00
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
2012-05-19 12:36:57 +04:00
/**
2012-12-25 21:17:32 +04:00
* This class provides convenient functions to send the correct http response headers
2012-05-19 12:36:57 +04:00
*/
2012-05-03 12:46:27 +04:00
class Response {
/**
* @brief Enable response caching by sending correct HTTP headers
2012-12-25 21:17:32 +04:00
* @param int $cache_time time to cache the response
2012-05-03 12:46:27 +04:00
* >0 cache time in seconds
* 0 and <0 enable default browser caching
* null cache indefinitly
*/
static public function enableCaching( $cache_time = null ) {
2013-01-07 02:59:02 +04:00
\OC_Response::enableCaching( $cache_time );
2012-05-03 12:46:27 +04:00
}
/**
* Checks and set Last-Modified header, when the request matches sends a
* 'not modified' response
2012-12-25 21:17:32 +04:00
* @param string $lastModified time when the reponse was last modified
2012-05-03 12:46:27 +04:00
*/
static public function setLastModifiedHeader( $lastModified ) {
2013-01-07 02:59:02 +04:00
\OC_Response::setLastModifiedHeader( $lastModified );
2012-05-03 12:46:27 +04:00
}
/**
* @brief disable browser caching
* @see enableCaching with cache_time = 0
*/
static public function disableCaching() {
2013-01-07 02:59:02 +04:00
\OC_Response::disableCaching();
2012-05-03 12:46:27 +04:00
}
/**
* Checks and set ETag header, when the request matches sends a
* 'not modified' response
2012-12-25 21:17:32 +04:00
* @param string $etag token to use for modification check
2012-05-03 12:46:27 +04:00
*/
static public function setETagHeader( $etag ) {
2013-01-07 02:59:02 +04:00
\OC_Response::setETagHeader( $etag );
2012-05-03 12:46:27 +04:00
}
/**
* @brief Send file as response, checking and setting caching headers
2012-12-25 21:17:32 +04:00
* @param string $filepath of file to send
2012-05-03 12:46:27 +04:00
*/
static public function sendFile( $filepath ) {
2013-01-07 02:59:02 +04:00
\OC_Response::sendFile( $filepath );
2012-05-03 12:46:27 +04:00
}
/**
2012-12-25 21:17:32 +04:00
* @brief Set response expire time
* @param string|\DateTime $expires date-time when the response expires
2012-05-03 12:46:27 +04:00
* string for DateInterval from now
* DateTime object when to expire response
*/
static public function setExpiresHeader( $expires ) {
2013-01-07 02:59:02 +04:00
\OC_Response::setExpiresHeader( $expires );
2012-05-03 12:46:27 +04:00
}
/**
* @brief Send redirect response
2012-12-25 21:17:32 +04:00
* @param string $location to redirect to
2012-05-03 12:46:27 +04:00
*/
static public function redirect( $location ) {
2013-01-07 02:59:02 +04:00
\OC_Response::redirect( $location );
2012-05-03 12:46:27 +04:00
}
2012-12-25 21:17:32 +04:00
}