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

Class: GalleryToolkitHelper_medium

Source Location: /modules/core/classes/helpers/GalleryToolkitHelper_medium.class

Class GalleryToolkitHelper_medium

Class Overview

This is a helper class that provides an interface to the GalleryToolkit api. Modules that implement a GalleryToolkit interface can register their various operations and properties using this class, and then classes that want to use a toolkit operation or property can locate the appropriate toolkit by operation/property and mime type.

Located in /modules/core/classes/helpers/GalleryToolkitHelper_medium.class [line 43]



		
		
		
		

Methods

[ Top ]
Method Summary
void   estimateDerivativeDimensions()  
void   getOperationMimeTypes()  
void   getOperations()  
void   getProperties()  
void   getRedundantPriorities()  
void   isSupportedOperationSequence()  
void   makeSupportedViewableOperationSequence()  
void   registerOperation()  
void   registerProperty()  
void   unregisterOperation()  
void   unregisterToolkit()  
void   unregisterToolkitsByModuleId()  

[ Top ]
Methods
estimateDerivativeDimensions  [line 611]

  void estimateDerivativeDimensions( &$derivative, $source  )

Parameters:
   &$derivative: 
   $source: 

API Tags:
See:  GalleryCoreApi::estimateDerivativeDimensions


[ Top ]
getOperationMimeTypes  [line 436]

  void getOperationMimeTypes( $operationName  )

Parameters:
   $operationName: 

API Tags:
See:  GalleryCoreApi::getToolkitOperationMimeTypes


[ Top ]
getOperations  [line 331]

  void getOperations( $mimeType  )

Parameters:
   $mimeType: 

API Tags:
See:  GalleryCoreApi::getToolkitOperations

Information Tags:
Todo:  use priorities for choosing the correct toolkit

[ Top ]
getProperties  [line 394]

  void getProperties( $mimeType  )

Parameters:
   $mimeType: 

API Tags:
See:  GalleryCoreApi::getToolkitProperties

Information Tags:
Todo:  use priorities for choosing the correct toolkit

[ Top ]
getRedundantPriorities  [line 468]

  void getRedundantPriorities( )


API Tags:
See:  GalleryCoreApi::getRedundantToolkitPriorities


[ Top ]
isSupportedOperationSequence  [line 512]

  void isSupportedOperationSequence( $mimeType, $operations  )

Parameters:
   $mimeType: 
   $operations: 

API Tags:
See:  GalleryCoreApi::isSupportedOperationSequence


[ Top ]
makeSupportedViewableOperationSequence  [line 541]

  void makeSupportedViewableOperationSequence( $mimeType, $operations, [ $prependConversion = true]  )

Parameters:
   $mimeType: 
   $operations: 
   $prependConversion: 

API Tags:
See:  GalleryCoreApi::makeSupportedViewableOperationSequence


[ Top ]
registerOperation  [line 48]

  void registerOperation( $toolkitId, $mimeTypes, $operationName, $parameterTypesArray, $description, [ $outputMimeType = ''], [ $priority = 5]  )

Parameters:
   $toolkitId: 
   $mimeTypes: 
   $operationName: 
   $parameterTypesArray: 
   $description: 
   $outputMimeType: 
   $priority: 

API Tags:
See:  GalleryCoreApi::registerToolkitOperation


[ Top ]
registerProperty  [line 143]

  void registerProperty( $toolkitId, $mimeTypes, $propertyName, $type, $description  )

Parameters:
   $toolkitId: 
   $mimeTypes: 
   $propertyName: 
   $type: 
   $description: 

API Tags:
See:  GalleryCoreApi::registerToolkitProperty


[ Top ]
unregisterOperation  [line 197]

  void unregisterOperation( $toolkitId, $operationName, [ $mimeTypes = array()]  )

Parameters:
   $toolkitId: 
   $operationName: 
   $mimeTypes: 

API Tags:
See:  GalleryCoreApi::unregisterToolkitOperation


[ Top ]
unregisterToolkit  [line 216]

  void unregisterToolkit( $toolkitId  )

Parameters:
   $toolkitId: 

API Tags:
See:  GalleryCoreApi::unregisterToolkit


[ Top ]
unregisterToolkitsByModuleId  [line 305]

  void unregisterToolkitsByModuleId( $moduleId  )

Parameters:
   $moduleId: 

API Tags:
See:  GalleryCoreApi::unregisterToolkitsByModuleId


[ Top ]

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