Class: ItemAddPlugin

Source Location: /modules/core/ItemAdd.inc

Class ItemAddPlugin

Class Overview

Interface for plugins to the ItemAdd view and controller.

Plugins provide alternate ways to add items into Gallery.

Located in /modules/core/ItemAdd.inc [line 730]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
ItemAddUploadApplet	ItemAdd plugin to show the upload applet
ItemAddFromPicasa	This plugin enables the upload of ZIP (or similar) Picasa export archives to import them into G2
ItemAddFromServer	This plugin will handle the addition of an items from the server filesystem.
ItemAddFromWeb	This plugin will handle the addition of items from other web pages.
ItemAddFromBrowser	This ItemAdd plugin adds items uploaded from the web browser.
ItemAddLinkItem	This plugin handles adding new link items
ItemAddPublishXp	Provide the user the option of downloading the Windows registry file.
ItemAddGalleryRemote	This ItemAdd plugin shows information about Gallery Remote
ItemAddWebCam	ItemAdd plugin to add a new webcam image
ItemAddWebDav	Add items with WebDAV. Handle WebDAV PUT requests and describe to users how to add items with WebDAV.

[ Top ]

Method Summary

array	getTitle()	Return a localized title for this plugin, suitable for display to the user
array	handleRequest()	Let the plugin handle the incoming request
array	isAppropriate()	Is this plugin appropriate at this time? Default is true.
array	loadTemplate()	Load the template with data from this plugin

[ Top ]

Methods

getTitle [line 771]

array getTitle(
)

Return a localized title for this plugin, suitable for display to the user

API Tags:

Return:

GalleryStatus a status code return-array (same as GalleryController::handleRequest)

Redefined in descendants as:

[ Top ]

handleRequest [line 761]

array handleRequest(
array
$form, 
&$item, 
&$addController, GalleryItem
$item, GalleryItemAddController
$addController 
)

Let the plugin handle the incoming request

Parameters:

array	$form:	the form values
GalleryItem	$item:
GalleryItemAddController	$addController:	A reference to the ItemAddController to be used for the post-processing calls.
	&$item:
	&$addController:

API Tags:

Return:	GalleryStatus a status code array error messages (request parameter errors). Stop processing on errors. array status data, 'addedFiles' entry should contain: array(array('fileName' => '...', 'id' => ##, 'warnings' => array of strings), ...)
See:	GalleryController::handleRequest

Redefined in descendants as:

[ Top ]

isAppropriate [line 781]

array isAppropriate(
)

Is this plugin appropriate at this time? Default is true.

API Tags:

Return:

GalleryStatus a status code boolean true or false

Redefined in descendants as:

[ Top ]

loadTemplate [line 743]

array loadTemplate(

&$template, 
&$form, GalleryItem
$item, GalleryTemplate
$template, array
$form 
)

Load the template with data from this plugin

Parameters:

GalleryTemplate	$template:
array	$form:	the form values
GalleryItem	$item:
	&$template:
	&$form:

API Tags:

Return:	GalleryStatus a status code string the path to a template file to include string localization domain for the template file
See:	GalleryView::loadTemplate

Redefined in descendants as:

[ Top ]

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

	GalleryCore UserInterface

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