Class MediaView

Methods to display or download any type of file

PHP versions 4 and 5

Licensed under The MIT License Redistributions of files must retain the above copyright notice.

Object

View

MediaView

Package: cake\cake\libs\view
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
Link: CakePHP(tm) Project
Since: CakePHP(tm) v 1.2.0.5714
Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified: $Date$
License: The MIT License
Location: view/media.php

Properties summary

$_headers public

array

Holds headers sent to browser before rendering media
$mimeType public

array

Holds known mime type mappings

Inherited Properties

__passedVars, __paths, __scripts, action, association, autoLayout, autoRender, base, cacheAction, data, ext, field, fieldSuffix, hasRendered, helpers, here, layout, layoutPath, loaded, model, modelId, modelScope, name, output, pageTitle, params, passedArgs, plugin, subDir, themeWeb, uuids, validationErrors, viewPath, viewVars _log

Method Summary

__construct() public

Constructor
_header() public

Method to set headers
_output() public

Method to output headers
render() public

Display or download the given file

Method Detail

__construct() public ¶

__construct( object $controller )

Constructor

Parameters

object $controller

Returns

View

Overrides

View::__construct()

_header() public ¶

_header( mixed $header , boolean $boolean = true )

Method to set headers

Parameters

mixed $header
boolean $boolean optional true

_output() public ¶

_output( )

Method to output headers

render() public ¶

render( )

Display or download the given file

Returns

unknown

Overrides

View::render()

Methods inherited from View

_getLayoutFileName() public ¶

_getLayoutFileName( $name = null )

Returns layout filename for this template as a string.

Returns

string
Filename for layout file (.ctp).

_getViewFileName() public ¶

_getViewFileName( string $name = null )

Returns filename of given action's template file (.ctp) as a string. CamelCased action names will be under_scored! This means that you can have LongActionNames that refer to long_action_names.ctp views.

Parameters

string $name optional null: $action Controller action to find template filename for

Returns

string
Template filename

_loadHelpers() public ¶

_loadHelpers( array $loaded , array $helpers , string $parent = null )

Loads helpers, with their dependencies.

Parameters

array $loaded: List of helpers that are already loaded.
array $helpers: List of helpers to load.
string $parent optional null: holds name of helper, if loaded helper has helpers

Returns

array

_missingView() public ¶

_missingView( string $file , $error = 'missingView' )

Return a misssing view error message

Parameters

string $file: $viewFileName the filename that should exist
$error optional 'missingView'

Returns

Object::cakeError()

_paths() public ¶

_paths( string $plugin = null , $cached = true )

Return all possible paths to find view files in order

Parameters

string $plugin optional null
$cached optional true

Returns

array
paths

_render() public ¶

_render( string $___viewFn , array $___dataForView , $loadHelpers = true , $cached = false )

Renders and returns output for given view filename with its array of data.

Parameters

string $___viewFn: Filename of the view
array $___dataForView: Data to include in rendered view
$loadHelpers optional true
$cached optional false

Returns

string
Rendered output

_triggerHelpers() public ¶

_triggerHelpers( string $callback )

Fire a callback on all loaded Helpers

Parameters

string $callback: name of callback fire.

addScript() public ¶

addScript( string $name , string $content = null )

Adds a script block or other element to be inserted in $scripts_for_layout in the of a document layout

Parameters

string $name
string $content optional null

element() public ¶

element( string $name , array $params = array() , $loadHelpers = false )

Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.

This realizes the concept of Elements, (or "partial layouts") and the $params array is used to send data to be used in the Element. Elements can be cached through use of the cache key.

Parameters

string $name: Name of template file in the/app/views/elements/ folder
array $params optional array(): Array of data to be made available to the for rendered view (i.e. the Element) Special params: cache - enable caching for this element accepts boolean or strtotime compatible string. Can also be an array if an array,'time' is used to specify duration of cache. 'key' can be used to create unique cache files.
$loadHelpers optional false

Returns

string
Rendered Element

entity() public ¶

entity( )

Returns the entity reference of the current context as an array of identity parts

Returns

array
An array containing the identity elements of an entity

error() public ¶

error( integer $code , string $name , string $message )

Displays an error page to the user. Uses layouts/error.ctp to render the page.

Parameters

integer $code: HTTP Error code (for instance: 404)
string $name: Name of the error (for instance: Not Found)
string $message: Error message as a web page

getVar() public ¶

getVar( $var )

Returns the contents of the given View variable(s)

Returns

array

getVars() public ¶

getVars( )

Returns a list of variables available in the current View context

Returns

array

renderCache() public ¶

renderCache( string $filename , string $timeStart )

Render cached view

Parameters

string $filename: the cache file to include
string $timeStart: the page render start time

renderElement() public deprecated ¶

renderElement( $name , $params = array() , $loadHelpers = false )

Deprecated

See

View::element

renderLayout() public ¶

renderLayout( string $content_for_layout , $layout = null )

Renders a layout. Returns output from _render(). Returns false on error. Several variables are created for use in layout. title_for_layout - contains page title content_for_layout - contains rendered view file scripts_for_layout - contains scripts added to header cakeDebug - if debug is on, cake debug information is added.

Parameters

string $content_for_layout: Content to render in a view, wrapped by the surrounding layout.
$layout optional null

Returns

mixed
Rendered output, or false on error

set() public ¶

set( mixed $one , mixed $two = null )

Allows a template or element to set a variable that will be available in a layout or other element. Analagous to Controller::set.

Parameters

mixed $one: A string or an array of data.
mixed $two optional null: Value in case $one is a string (which then works as the key). Unused if $one is an associative array, otherwise serves as the values to $one's keys.

Returns

unknown

uuid() public ¶

uuid( string $object , string $url )

Generates a unique, non-random DOM ID for an object, based on the object type and the target URL.

Parameters

string $object: Type of object, i.e. 'form' or 'link'
string $url: The object's target URL

Returns

string

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

API for logging events.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$_headers` ¶

public array

Holds headers sent to browser before rendering media

array()

`$mimeType` ¶

public array

Holds known mime type mappings

array('ai' => 'application/postscript', 'bcpio' => 'application/x-bcpio', 'bin' => 'application/octet-stream',
                            'ccad' => 'application/clariscad', 'cdf' => 'application/x-netcdf', 'class' => 'application/octet-stream',
                            'cpio' => 'application/x-cpio', 'cpt' => 'application/mac-compactpro', 'csh' => 'application/x-csh',
                            'csv' => 'application/csv', 'dcr' => 'application/x-director', 'dir' => 'application/x-director',
                            'dms' => 'application/octet-stream', 'doc' => 'application/msword', 'drw' => 'application/drafting',
                            'dvi' => 'application/x-dvi', 'dwg' => 'application/acad', 'dxf' => 'application/dxf', 'dxr' => 'application/x-director',
                            'eps' => 'application/postscript', 'exe' => 'application/octet-stream', 'ez' => 'application/andrew-inset',
                            'flv' => 'video/x-flv', 'gtar' => 'application/x-gtar', 'gz' => 'application/x-gzip',
                            'bz2' => 'application/x-bzip', '7z' => 'application/x-7z-compressed', 'hdf' => 'application/x-hdf',
                            'hqx' => 'application/mac-binhex40', 'ips' => 'application/x-ipscript', 'ipx' => 'application/x-ipix',
                            'js' => 'application/x-javascript', 'latex' => 'application/x-latex', 'lha' => 'application/octet-stream',
                            'lsp' => 'application/x-lisp', 'lzh' => 'application/octet-stream', 'man' => 'application/x-troff-man',
                            'me' => 'application/x-troff-me', 'mif' => 'application/vnd.mif', 'ms' => 'application/x-troff-ms',
                            'nc' => 'application/x-netcdf', 'oda' => 'application/oda', 'pdf' => 'application/pdf',
                            'pgn' => 'application/x-chess-pgn', 'pot' => 'application/mspowerpoint', 'pps' => 'application/mspowerpoint',
                            'ppt' => 'application/mspowerpoint', 'ppz' => 'application/mspowerpoint', 'pre' => 'application/x-freelance',
                            'prt' => 'application/pro_eng', 'ps' => 'application/postscript', 'roff' => 'application/x-troff',
                            'scm' => 'application/x-lotusscreencam', 'set' => 'application/set', 'sh' => 'application/x-sh',
                            'shar' => 'application/x-shar', 'sit' => 'application/x-stuffit', 'skd' => 'application/x-koan',
                            'skm' => 'application/x-koan', 'skp' => 'application/x-koan', 'skt' => 'application/x-koan',
                            'smi' => 'application/smil', 'smil' => 'application/smil', 'sol' => 'application/solids',
                            'spl' => 'application/x-futuresplash', 'src' => 'application/x-wais-source', 'step' => 'application/STEP',
                            'stl' => 'application/SLA', 'stp' => 'application/STEP', 'sv4cpio' => 'application/x-sv4cpio',
                            'sv4crc' => 'application/x-sv4crc', 'svg' => 'image/svg+xml', 'svgz' => 'image/svg+xml',
                            'swf' => 'application/x-shockwave-flash', 't' => 'application/x-troff',
                            'tar' => 'application/x-tar', 'tcl' => 'application/x-tcl', 'tex' => 'application/x-tex',
                            'texi' => 'application/x-texinfo', 'texinfo' => 'application/x-texinfo', 'tr' => 'application/x-troff',
                            'tsp' => 'application/dsptype', 'unv' => 'application/i-deas', 'ustar' => 'application/x-ustar',
                            'vcd' => 'application/x-cdlink', 'vda' => 'application/vda', 'xlc' => 'application/vnd.ms-excel',
                            'xll' => 'application/vnd.ms-excel', 'xlm' => 'application/vnd.ms-excel', 'xls' => 'application/vnd.ms-excel',
                            'xlw' => 'application/vnd.ms-excel', 'zip' => 'application/zip', 'aif' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff',
                            'aiff' => 'audio/x-aiff', 'au' => 'audio/basic', 'kar' => 'audio/midi', 'mid' => 'audio/midi',
                            'midi' => 'audio/midi', 'mp2' => 'audio/mpeg', 'mp3' => 'audio/mpeg', 'mpga' => 'audio/mpeg',
                            'ra' => 'audio/x-realaudio', 'ram' => 'audio/x-pn-realaudio', 'rm' => 'audio/x-pn-realaudio',
                            'rpm' => 'audio/x-pn-realaudio-plugin', 'snd' => 'audio/basic', 'tsi' => 'audio/TSP-audio', 'wav' => 'audio/x-wav',
                            'asc' => 'text/plain', 'c' => 'text/plain', 'cc' => 'text/plain', 'css' => 'text/css', 'etx' => 'text/x-setext',
                            'f' => 'text/plain', 'f90' => 'text/plain', 'h' => 'text/plain', 'hh' => 'text/plain', 'htm' => 'text/html',
                            'html' => 'text/html', 'm' => 'text/plain', 'rtf' => 'text/rtf', 'rtx' => 'text/richtext', 'sgm' => 'text/sgml',
                            'sgml' => 'text/sgml', 'tsv' => 'text/tab-separated-values', 'tpl' => 'text/template', 'txt' => 'text/plain',
                            'xml' => 'text/xml', 'avi' => 'video/x-msvideo', 'fli' => 'video/x-fli', 'mov' => 'video/quicktime',
                            'movie' => 'video/x-sgi-movie', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg',
                            'qt' => 'video/quicktime', 'viv' => 'video/vnd.vivo', 'vivo' => 'video/vnd.vivo', 'gif' => 'image/gif',
                            'ief' => 'image/ief', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg',
                            'pbm' => 'image/x-portable-bitmap', 'pgm' => 'image/x-portable-graymap', 'png' => 'image/png',
                            'pnm' => 'image/x-portable-anymap', 'ppm' => 'image/x-portable-pixmap', 'ras' => 'image/cmu-raster',
                            'rgb' => 'image/x-rgb', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'xbm' => 'image/x-xbitmap',
                            'xpm' => 'image/x-xpixmap', 'xwd' => 'image/x-xwindowdump', 'ice' => 'x-conference/x-cooltalk',
                            'iges' => 'model/iges', 'igs' => 'model/iges', 'mesh' => 'model/mesh', 'msh' => 'model/mesh',
                            'silo' => 'model/mesh', 'vrml' => 'model/vrml', 'wrl' => 'model/vrml',
                            'mime' => 'www/mime', 'pdb' => 'chemical/x-pdb', 'xyz' => 'chemical/x-pdb')

Classes

Functions

Class MediaView

Properties summary

Inherited Properties

Method Summary

__construct() public

_header() public

_output() public

render() public

Method Detail

__construct() public ¶

Parameters

Returns

Overrides

_header() public ¶

Parameters

_output() public ¶

render() public ¶

Returns

Overrides

Methods inherited from View

_getLayoutFileName() public ¶

Returns

_getViewFileName() public ¶

Parameters

Returns

_loadHelpers() public ¶

Parameters

Returns

_missingView() public ¶

Parameters

Returns

_paths() public ¶

Parameters

Returns

_render() public ¶

Parameters

Returns

_triggerHelpers() public ¶

Parameters

addScript() public ¶

Parameters

element() public ¶

Parameters

Returns

entity() public ¶

Returns

error() public ¶

Parameters

getVar() public ¶

Returns

getVars() public ¶

Returns

renderCache() public ¶

Parameters

renderElement() public deprecated ¶

Deprecated

See

renderLayout() public ¶

Parameters

Returns

set() public ¶

Parameters

Returns

uuid() public ¶

Parameters

Returns

Methods inherited from Object

Object() public ¶

Returns

__openPersistent() public ¶

Parameters

_persist() public ¶

Parameters

Returns

_savePersistent() public ¶

Parameters

Returns

_set() public ¶

`$_headers` ¶

`$mimeType` ¶