adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 03:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding a doc block and code sample for MediaView.

Browse source
This commit is contained in:
mark_story 2010-12-22 21:49:53 -05:00
parent 27477bbac3
commit aff5cd7e15
1 changed files with 47 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
cake/libs/view/media.php
View file

@ -19,6 +19,41 @@
*/
App::import('View', 'View', false);
/**
* Media View provides a custom view implementation for sending files to visitors. Its great
* for making the response of a controller action be a file that is saved somewhere on the filesystem.
*
* An example use comes from the CakePHP internals. MediaView is used to serve plugin and theme assets,
* as they are not normally accessible from an application's webroot. Unlike other views, MediaView
* uses several viewVars that have special meaning:
*
* - `id` The filename on the server's filesystem, including extension.
* - `name` The filename that will be sent to the user, specified without the extension.
* - `download` Set to true to set a `Content-Disposition` header. This is ideal for file downloads.
* - `extension` The extension of the file being served. This is used to set the mimetype
* - `path` The absolute path, including the trailing / on the server's filesystem to `id`.
* - `mimeType` The mime type of the file if CakeResponse doesn't know about it.
*
* ### Usage
*
* {{{
* class ExampleController extends AppController {
* function download () {
* $this->view = 'Media';
* $params = array(
* 'id' => 'example.zip',
* 'name' => 'example',
* 'download' => true,
* 'extension' => 'zip',
* 'path' => APP . 'files' . DS
* );
* $this->set($params);
* }
* }
* }}}
*
* @package cake.libs.view
*/
class MediaView extends View {
/**
* Indicates whether response gzip compression was enabled for this class
@ -34,11 +69,10 @@ class MediaView extends View {
*/
public $response = null;
/**
* Constructor
*
* @param object $controller
* @param object $controller The controller with viewVars
*/
function __construct($controller = null) {
parent::__construct($controller);
@ -53,7 +87,7 @@ class MediaView extends View {
/**
* Display or download the given file
*
* @return unknown
* @return mixed
*/
function render() {
$name = $download = $extension = $id = $modified = $path = $size = $cache = $mimeType = $compress = null;
@ -160,6 +194,12 @@ class MediaView extends View {
return false;
}
/**
* Reads out a file handle, and echos the content to the client.
*
* @param resource $handle A file handle or stream
* @return void
*/
protected function _sendFile($handle) {
$chunkSize = 8192;
$buffer = '';
@ -180,6 +220,7 @@ class MediaView extends View {
/**
* Returns true if connection is still active
*
* @return boolean
*/
protected function _isActive() {
@ -188,6 +229,7 @@ class MediaView extends View {
/**
* Clears the contents of the topmost output buffer and discards them
*
* @return boolean
*/
protected function _clearBuffer() {
@ -196,6 +238,8 @@ class MediaView extends View {
/**
* Flushes the contents of the output buffer
*
* @return void
*/
protected function _flushBuffer() {
@flush();