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

Class: ItemEditWatermark

Source Location: /modules/watermark/ItemEditWatermark.inc

Class ItemEditWatermark

Class Overview

This edit plugin allows you to customize the watermark for an image or album

Located in /modules/watermark/ItemEditWatermark.inc [line 33]

ItemEditPlugin
   |
   --ItemEditWatermark

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ItemEditPlugin

ItemEditPlugin::getTitle()
Return a localized title for this plugin, suitable for display to the user
ItemEditPlugin::handleRequest()
Let the plugin handle the incoming request
ItemEditPlugin::isSupported()
Does this plugin support the given item type?
ItemEditPlugin::loadTemplate()
Load the template with data from this plugin
ItemEditPlugin::_checkForOperation()
Check to see if a given operation is available for any of a set of mime types

[ Top ]
Method Summary
void   bulkOperation()  
void   getTitle()  
void   handleRequest()  
void   isSupported()  
void   loadTemplate()  
void   removeWatermark()  

[ Top ]
Methods
bulkOperation  [line 115]

  void bulkOperation( $item, $operation, $params, $recursive, $message  )

Parameters:
   $item: 
   $operation: 
   $params: 
   $recursive: 
   $message: 


[ Top ]
getTitle  [line 404]

  void getTitle( )


API Tags:
See:  ItemEditPlugin::getTitle


Redefinition of:
ItemEditPlugin::getTitle()
Return a localized title for this plugin, suitable for display to the user

[ Top ]
handleRequest  [line 38]

  void handleRequest( $form, &$item, &$preferred  )

Parameters:
   $form: 
   &$item: 
   &$preferred: 

API Tags:
See:  ItemEditPlugin::handleRequest


Redefinition of:
ItemEditPlugin::handleRequest()
Let the plugin handle the incoming request

[ Top ]
isSupported  [line 350]

  void isSupported( $item, $thumbnail  )

Parameters:
   $item: 
   $thumbnail: 

API Tags:
See:  ItemEditPlugin::isSupported

Information Tags:
Todo:  Broaden this interface to allow a GalleryStatus return code

Redefinition of:
ItemEditPlugin::isSupported()
Does this plugin support the given item type?

[ Top ]
loadTemplate  [line 257]

  void loadTemplate( &$template, &$form, $item, $thumbnail  )

Parameters:
   &$template: 
   &$form: 
   $item: 
   $thumbnail: 

API Tags:
See:  ItemEditPlugin::loadTemplate


Redefinition of:
ItemEditPlugin::loadTemplate()
Load the template with data from this plugin

[ Top ]
removeWatermark  [line 183]

  void removeWatermark( $itemId  )

Parameters:
   $itemId: 


[ Top ]

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