MimeView Class Reference
[Mime]

A content view of any mime type, not only text/html. More...

Inheritance diagram for MimeView:

List of all members.

Public Member Functions
	__construct ($template, $page_data)
	Contructor takes a name and the page data.
	display_file ($file)
	Send given File to the browser.
Public Attributes
const	EXPIRES = 'expires'
const	MIMETYPE = 'mimetype'
Protected Member Functions
	render_postprocess (&$rendered_content, $policy)
	Called after content is rendered, always.
	should_cache ()
	Always returns false.

---

Detailed Description

A content view of any mime type, not only text/html.

Assign 'data' and MimeView::MIMETYPE to the created view like this:

 $imagedata = file_get_contents('my/image.png'); 
 $view = ViewFactory::create_view(ViewFactoryMime::MIME, 'mime/view', $page_data);
 $view->assign('data', $imagedata);
 $view->assign(MimeView::MIMETYPE, 'image/png');
 $view->render();

For convenience, the same can be achieved using display_file():

 $view = ViewFactory::create_view(ViewFactoryMime::MIME, 'mime/view', $page_data);
 $view->display_file('my/image.png');
 $view->render();

Mime views are normally cached, like any other content. When using a mime view, the according route therefor should disable server side caching, but enable it at client side. The simplest way to fullfill this is to use the MimeCacheManager.

Not caching on client side may lead to trouble in IE 6 when downloading data with SSL encryption.

See also:

http://support.microsoft.com/kb/815313/en-us

Author:

Gerd Riesselmann

Definition at line 34 of file mimeview.cls.php.

---

Constructor & Destructor Documentation

MimeView::__construct	(	$	template,
		$	page_data
	)

Contructor takes a name and the page data.

Reimplemented from ContentViewBase.

Definition at line 41 of file mimeview.cls.php.

                                                           {
                parent::__construct($template, $page_data);
                $page_data->page_template = 'emptypage';
                $this->assign(self::MIMETYPE, 'application/octet-stream');
                $this->assign(self::EXPIRES, 0);
        }

---

Member Function Documentation

MimeView::display_file

(

$

file

)

Send given File to the browser.

Parameters:

string

$file Path to file

Definition at line 97 of file mimeview.cls.php.

                                            {
                if (file_exists($file)) {
                        $modification = filemtime($file);
                        if ($modification) {
                                $this->page_data->get_cache_manager()->set_creation_datetime($modification);
                        }
                        
                        // Detect mime type
                        $mime_type = 'application/octect-stream';
                        if (function_exists('finfo_open')) {
                                $handle = finfo_open(FILEINFO_MIME); // return mime type ala mimetype extension
                                $mime_type = finfo_file($handle, $file);
                                finfo_close($handle);
                        }
                        else if (function_exists('mime_content_type')) {
                                $mime_type = mime_content_type($file);
                        }
                        else {
                                $path_info = pathinfo($file);
                        $path_ext = $path_info['extension'];
                                // No MAGIC functions enabled, do a primitiv lookup based upon file ending
                                $types = array(
                                        'gif' => 'image/gif',
                                        'png' => 'image/png',
                                        'jpg' => 'image/jpeg',
                                );
                                foreach($types as $extension => $type) {
                                        if ($path_ext === $extension) {
                                                $mime_type = $type;
                                                break;  
                                        }
                                }                               
                        }
                        $this->assign(self::MIMETYPE, $mime_type);

                        $this->assign('data', file_get_contents($file));
                }
        }

MimeView::render_postprocess	(	&$	rendered_content,
		$	policy
	)			[protected]

Called after content is rendered, always.

Parameters:

mixed

$rendered_content The content rendered $policy If set to IView::DISPLAY, content is printed, if false it is returned only

Returns:

void

Reimplemented from ViewBase.

Definition at line 64 of file mimeview.cls.php.

                                                                           {
                parent::render_postprocess($rendered_content, $policy);
                
                if (!Common::flag_is_set($policy, self::CONTENT_ONLY)) {
                        $mimetype = $this->retrieve(self::MIMETYPE);
                        
                        // GR: Disabled, since this is too generic. Left to app to handle
                        //if (RequestInfo::current()->is_ssl()) {
                        //      Common::header('Cache-Control', 'maxage=3600', true); //Fix for IE in SSL 
                        //}
                        
                        if (strpos($mimetype, 'charset') === false) {
                                $mimetype .= '; charset=' . GyroLocale::get_charset();
                        }                       
                        GyroHeaders::set('Content-Type', $mimetype, true);
                        
                        // Expires Header
                        $ex = $this->retrieve(self::EXPIRES);
                        if ($ex) {
                                if ($ex < 10 * GyroDate::ONE_YEAR) {
                                        // $ex is a duration
                                        $ex = time() + $ex;
                                }
                                $this->page_data->get_cache_manager()->set_expiration_datetime($ex);
                        }
                }
        }       

MimeView::should_cache

(

)

[protected]

Always returns false.

Returns:

bool

Reimplemented from ViewBase.

Definition at line 53 of file mimeview.cls.php.

                                          {
                return false;
        }       

---

Member Data Documentation

const MimeView::EXPIRES = 'expires'

Definition at line 36 of file mimeview.cls.php.

const MimeView::MIMETYPE = 'mimetype'

Definition at line 35 of file mimeview.cls.php.

---

The documentation for this class was generated from the following file:

• gyro/modules/mime/view/base/mimeview.cls.php