Class: ItemAddOption

Source Location: /modules/core/ItemAdd.inc

Class ItemAddOption

Class Overview

Interface for options to the ItemAdd view and controller.

Options allow us to provide extra UI in the views and extra processing in the controller so that we can add new functionality like watermarking, quotas, etc to every ItemAddPlugin

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

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
FlashVideoOption	This ItemAddOption adds the FlashVideoRenderer for any video/x-flv item.
SetSizeOption	ItemAdd option using the size limit values to resize gallery images when uploaded.
ExifDescriptionOption	This ItemAddOption uses the EXIF description value for the gallery item summary/description and the IPTC keywords for the gallery item keywords when the image is uploaded.
WatermarkOption	This ItemAddOption allows the user to pick a watermark to apply to the image upon upload.
MovieThumbnailOption	This ItemAddOption adds a watermark on movie thumbnails.
ItemAddTestOption	Test ItemAddOption
CreateThumbnailOption	This ItemAddOption allows the user to choose to create thumbnails when the image is uploaded.
Getid3DescriptionOption	This ItemAddOption uses an mp3's id3 title value for the item title when an mp3 is uploaded
MP3AudioOption	This ItemAddOption adds the MP3AudioRenderer for any audio/mpeg item.
RestrictMimeOption	This ItemAddOption rejects uploads for selected mime types.
DiskQuotaOption	This ItemAddOption enforces disk quotas
NotificationItemsAddedOption	This ItemAddOption sends a Notification event for the newly created item.

[ Top ]

Method Summary

static array	getAllAddOptions()	Return all the available option plugins
array	handleRequestAfterAdd()	Let the plugin handle the incoming request. We expect the $items to be locked.
array	isAppropriate()	Is this option appropriate at this time?
array	loadTemplate()	Load the template with data from this plugin

[ Top ]

Methods

static method getAllAddOptions [line 803]

static array getAllAddOptions(
)

Return all the available option plugins

API Tags:

Return:

GalleryStatus a status code array ItemAddOption instances

[ Top ]

handleRequestAfterAdd [line 858]

array handleRequestAfterAdd(
array
$form, array
$items 
)

Let the plugin handle the incoming request. We expect the $items to be locked.

Parameters:

array	$form:	the form values
array	$items:	GalleryDataItems

API Tags:

Return:	GalleryStatus a status code array localized error messages. Attempt to continue processing on errors since the items have already been added and post-processing will continue. array localized warning messages
See:	GalleryController::handleRequest

Redefined in descendants as:

[ Top ]

isAppropriate [line 868]

array isAppropriate(
)

Is this option appropriate at this time?

API Tags:

Return:

GalleryStatus a status code boolean true or false

Redefined in descendants as:

[ Top ]

loadTemplate [line 843]

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:02 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore UserInterface

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