diff options
Diffstat (limited to 'lib/public/response.php')
-rw-r--r-- | lib/public/response.php | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/lib/public/response.php b/lib/public/response.php index 95e67a85720..de0c3f25347 100644 --- a/lib/public/response.php +++ b/lib/public/response.php @@ -31,27 +31,27 @@ namespace OCP; /** - * This class provides convinient functions to send the correct http response headers + * This class provides convenient functions to send the correct http response headers */ class Response { /** * @brief Enable response caching by sending correct HTTP headers - * @param $cache_time time to cache the response + * @param int $cache_time time to cache the response * >0 cache time in seconds * 0 and <0 enable default browser caching * null cache indefinitly */ static public function enableCaching( $cache_time = null ) { - return(\OC_Response::enableCaching( $cache_time )); + \OC_Response::enableCaching( $cache_time ); } /** * Checks and set Last-Modified header, when the request matches sends a * 'not modified' response - * @param $lastModified time when the reponse was last modified + * @param string $lastModified time when the reponse was last modified */ static public function setLastModifiedHeader( $lastModified ) { - return(\OC_Response::setLastModifiedHeader( $lastModified )); + \OC_Response::setLastModifiedHeader( $lastModified ); } /** @@ -59,41 +59,41 @@ class Response { * @see enableCaching with cache_time = 0 */ static public function disableCaching() { - return(\OC_Response::disableCaching()); + \OC_Response::disableCaching(); } /** * Checks and set ETag header, when the request matches sends a * 'not modified' response - * @param $etag token to use for modification check + * @param string $etag token to use for modification check */ static public function setETagHeader( $etag ) { - return(\OC_Response::setETagHeader( $etag )); + \OC_Response::setETagHeader( $etag ); } /** * @brief Send file as response, checking and setting caching headers - * @param $filepath of file to send + * @param string $filepath of file to send */ static public function sendFile( $filepath ) { - return(\OC_Response::sendFile( $filepath )); + \OC_Response::sendFile( $filepath ); } /** - * @brief Set reponse expire time - * @param $expires date-time when the response expires + * @brief Set response expire time + * @param string|\DateTime $expires date-time when the response expires * string for DateInterval from now * DateTime object when to expire response */ static public function setExpiresHeader( $expires ) { - return(\OC_Response::setExpiresHeader( $expires )); + \OC_Response::setExpiresHeader( $expires ); } /** * @brief Send redirect response - * @param $location to redirect to + * @param string $location to redirect to */ static public function redirect( $location ) { - return(\OC_Response::redirect( $location )); + \OC_Response::redirect( $location ); } -}
\ No newline at end of file +} |