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 
		
		 | 
		
		  
		
	 
 
	
	
	
	
		Methods 
		
		
			
	
    
     
		void estimateDerivativeDimensions(
&$derivative, 
$source 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::estimateDerivativeDimensions | 
   
 
		
		
	
 
	
    
     
		void getOperationMimeTypes(
$operationName 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::getToolkitOperationMimeTypes | 
   
 
		
		
	
 
	
    
     
		void getOperations(
$mimeType 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::getToolkitOperations | 
   
 
Information Tags:
  
    | Todo:   | use priorities for choosing the correct toolkit | 
   
 
		
		
	
 
	
    
     
		void getProperties(
$mimeType 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::getToolkitProperties | 
   
 
Information Tags:
  
    | Todo:   | use priorities for choosing the correct toolkit | 
   
 
		
		
	
 
	
    
     
		void getRedundantPriorities(
)
     |   
     |  
  
	
	
	API Tags:
  
    | See:   | GalleryCoreApi::getRedundantToolkitPriorities | 
   
 
		
		
	
 
	
    
     
		void isSupportedOperationSequence(
$mimeType, 
$operations 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::isSupportedOperationSequence | 
   
 
		
		
	
 
	
    
     
		void makeSupportedViewableOperationSequence(
$mimeType, 
$operations, [
$prependConversion = true] 
)
     |   
     |  
  
	
			Parameters:
			
					| 
				   | 
				
				$mimeType:  | 
				
							 |  
					| 
				   | 
				
				$operations:  | 
				
							 |  
					| 
				   | 
				
				$prependConversion:  | 
				
							 |  
				 
	
	API Tags:
  
    | See:   | GalleryCoreApi::makeSupportedViewableOperationSequence | 
   
 
		
		
	
 
	
    
     
		void registerOperation(
$toolkitId, 
$mimeTypes, 
$operationName, 
$parameterTypesArray, 
$description, [
$outputMimeType = ''], [
$priority = 5] 
)
     |   
     |  
  
	
			Parameters:
			
					| 
				   | 
				
				$toolkitId:  | 
				
							 |  
					| 
				   | 
				
				$mimeTypes:  | 
				
							 |  
					| 
				   | 
				
				$operationName:  | 
				
							 |  
					| 
				   | 
				
				$parameterTypesArray:  | 
				
							 |  
					| 
				   | 
				
				$description:  | 
				
							 |  
					| 
				   | 
				
				$outputMimeType:  | 
				
							 |  
					| 
				   | 
				
				$priority:  | 
				
							 |  
				 
	
	API Tags:
  
    | See:   | GalleryCoreApi::registerToolkitOperation | 
   
 
		
		
	
 
	
    
     
		void registerProperty(
$toolkitId, 
$mimeTypes, 
$propertyName, 
$type, 
$description 
)
     |   
     |  
  
	
			Parameters:
			
					| 
				   | 
				
				$toolkitId:  | 
				
							 |  
					| 
				   | 
				
				$mimeTypes:  | 
				
							 |  
					| 
				   | 
				
				$propertyName:  | 
				
							 |  
					| 
				   | 
				
				$type:  | 
				
							 |  
					| 
				   | 
				
				$description:  | 
				
							 |  
				 
	
	API Tags:
  
    | See:   | GalleryCoreApi::registerToolkitProperty | 
   
 
		
		
	
 
	
    
     
		void unregisterOperation(
$toolkitId, 
$operationName, [
$mimeTypes = array()] 
)
     |   
     |  
  
	
			Parameters:
			
					| 
				   | 
				
				$toolkitId:  | 
				
							 |  
					| 
				   | 
				
				$operationName:  | 
				
							 |  
					| 
				   | 
				
				$mimeTypes:  | 
				
							 |  
				 
	
	API Tags:
  
    | See:   | GalleryCoreApi::unregisterToolkitOperation | 
   
 
		
		
	
 
	
    
     
		void unregisterToolkit(
$toolkitId 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::unregisterToolkit | 
   
 
		
		
	
 
	
    
     
		void unregisterToolkitsByModuleId(
$moduleId 
)
     |   
     |  
  
	
			Parameters:
			
	
	API Tags:
  
    | See:   | GalleryCoreApi::unregisterToolkitsByModuleId | 
   
 
		
		
	
 
		 
	 
        
       |   
     |