phpDocumentor GalleryCore
Classes
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: GalleryRenderer

Source Location: /modules/core/classes/GalleryRenderer.class

Class GalleryRenderer

Class Overview

An interface for classes that render GalleryDataItems in different formats.

Located in /modules/core/classes/GalleryRenderer.class [line 35]



		
				Author(s):
		
API Tags:
Abstract:  

Methods

[ Top ]
Direct descendents
Child Class Description
FlashVideoRenderer A renderer for Flash Video.
ItemTestRenderer Test renderer
MP3AudioRenderer A renderer for MP3 Audio.
PanoramaRenderer A GalleryRenderer that uses the panorama applet

[ Top ]
Method Summary
boolean   canBeViewedInline()   Can this renderer display the given item?
string   render()   Render the given GalleryItem in the given output format. For example, you can render a GalleryPhotoItem with an <img> tag in the HTML format, whereas GalleryMovieItem would use <object> or <embed>.

[ Top ]
Methods
canBeViewedInline  [line 43]

  boolean canBeViewedInline( GalleryDataItem $item  )

Can this renderer display the given item?

Parameters:
GalleryDataItem   $item: 

API Tags:
Return:  true if this data item can be viewed inline


Redefined in descendants as:

[ Top ]
render  [line 63]

  string render( string $format, GalleryEntity $entity, GalleryItem $item, array $params  )

Render the given GalleryItem in the given output format. For example, you can render a GalleryPhotoItem with an <img> tag in the HTML format, whereas GalleryMovieItem would use <object> or <embed>.

This method takes an entity to render, and the item which has its metadata. In some cases, these will be the same thing (like when rendering the original of a GalleryPhotoItem). In other cases, it will be different, like when you're rendering a resize. In that case, the entity would be a GalleryDerivative and the item would be the GalleryPhotoItem.

Parameters:
string   $format:  the format (eg. "HTML")
GalleryEntity   $entity:  the entity to render
GalleryItem   $item:  the parent item
array   $params:  format specific key value pairs

API Tags:
Return:  formatted output


Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:03:22 -0700 by phpDocumentor 1.3.0RC6