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

Class: ItemEditPlugin

Source Location: /modules/core/ItemEdit.inc

Class ItemEditPlugin

Class Overview

Interface for plugins to the ItemEdit view and controller

Located in /modules/core/ItemEdit.inc [line 385]



		
				Author(s):
		
API Tags:
Abstract:  

Methods

[ Top ]
Direct descendents
Child Class Description
MultiLangItemEdit This plugin will handle storing multilanguage captions for GalleryItems
ItemEditWatermark This edit plugin allows you to customize the watermark for an image or album
ItemEditThumbOffset This plugin handles selecting the time offset to use for movie thumbnails
ItemEditThumbPage This plugin handles selecting the page to use for thumbnails
ItemEditControllerTestPluginFailAndWarn Test plugin that fails
ItemEditControllerTestPluginRequiresProgressBar Test plugin that requires a progress bar
ItemEditMovie Plugin for editing Movies
ItemEditPhoto This plugin will handle the editing of a photo
ItemEditRotateAndScalePhoto This plugin will handle applying operations to a photo
ItemEditPhotoThumbnail This edit plugin allows you to customize the photo's thumbnail
ItemEditTheme This plugin will handle the changes users make to theme settings for an album.
ItemEditAnimation Plugin for editing Animations
ItemEditItem Plugin for editing data common to all items
ItemEditAlbum This plugin will handle the changes users make to an album.
CustomFieldItemEdit This plugin will handle assigning values to custom fields

[ 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
boolean   isSupported()   Does this plugin support the given item type?
array   loadTemplate()   Load the template with data from this plugin
array   _checkForOperation()   Check to see if a given operation is available for any of a set of mime types

[ Top ]
Methods
handleRequest  [line 425]

  array handleRequest( array $form, &$item, &$preferred, GalleryItem $item, GalleryDerivative $preferred  )

Let the plugin handle the incoming request

Parameters:
array   $form:  the form values
GalleryItem   $item: 
GalleryDerivative   $preferred:  item's preferred derivative, if there is one
   &$item: 
   &$preferred: 

API Tags:
Return:  GalleryStatus a status code array error messages string localized status message boolean true if progress bar is needed
See:  GalleryController::handleRequest


Redefined in descendants as:

[ Top ]
loadTemplate  [line 409]

  array loadTemplate( &$template, &$form, GalleryItem $item, GalleryDerivative $thumbnail, GalleryTemplate $template, array $form  )

Load the template with data from this plugin

Parameters:
GalleryTemplate   $template: 
array   $form:  the form values
GalleryItem   $item: 
GalleryDerivative   $thumbnail:  item's thumbnail
   &$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 ]
_checkForOperation  [line 449]

  array _checkForOperation( string $operation, array $mimeTypes  )

Check to see if a given operation is available for any of a set of mime types

Parameters:
string   $operation:  the operation (eg. 'rotate' or 'scale')
array   $mimeTypes: 

API Tags:
Return:  GalleryStatus a status code bool true if any of the mime types are supported
Access:  protected


[ Top ]

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