Class: ImageFrameInterface_1_1

Source Location: /modules/imageframe/classes/ImageFrameInterface_1_1.class

Class ImageFrameInterface_1_1

Class Overview

This is an interface for the ImageFrame module. Themes or modules that wish to display a frame around a photo can utilize an implementation of this interface.

Located in /modules/imageframe/classes/ImageFrameInterface_1_1.class [line 39]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
ImageFrameImpl	Implementation of the ImageFrameInterface for rendering a frame around an image

[ Top ]

Method Summary

array	getImageFrameList()	Get list of available image frames
array	getSampleUrl()	Get url for displaying samples of all image frames. Pass an itemId to the view to use the thumbnail of that item in the samples; otherwise a default image will be used.
GalleryStatus	init()	Prepare imageframe system. Pass in list of ids that may be used in a view.

[ Top ]

Methods

getImageFrameList [line 47]

array getImageFrameList(
)

Get list of available image frames

API Tags:

Return:

GalleryStatus a status code, array(frame_id=>localized_frame_name)

Redefined in descendants as:

ImageFrameImpl::getImageFrameList()

[ Top ]

getSampleUrl [line 73]

array getSampleUrl(
[
$itemId = null] 
)

Get url for displaying samples of all image frames. Pass an itemId to the view to use the thumbnail of that item in the samples; otherwise a default image will be used.

Parameters:

$itemId:

API Tags:

Return:

GalleryStatus a status code, string view url

Redefined in descendants as:

ImageFrameImpl::getSampleUrl()

[ Top ]

init [line 62]

GalleryStatus init(

&$template, mixed
$frameIds, GalleryTemplate
$template 
)

Prepare imageframe system. Pass in list of ids that may be used in a view.

Use {g->block type="imageframe" frame=".."} .. {/g->block} where needed, passing the frame to render and the frame contents. The image in the content must have id="%ID%" and class="%CLASS%". See example in SampleHead.tpl/SampleBody.tpl. This method may be called more than once in a request.

Parameters:

GalleryTemplate	$template:
mixed	$frameIds:	array of frame ids to prepare for use or single frame id
	&$template:

API Tags:

Return:

a status code

Redefined in descendants as:

ImageFrameImpl::init()

[ Top ]

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

	ImageFrame Classes

[ class tree: ImageFrame ] [ index: ImageFrame ] [ all elements ]