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

Class: SizeLimitHelper

Source Location: /modules/sizelimit/classes/SizeLimitHelper.class

Class SizeLimitHelper

Class Overview
Method Summary
array   applyLimits()   Reduce the item file size without preserving the original
array   buildDerivativeWithLimits()   Set up a preferred derivative that conforms to size limits
GalleryStatus   _updateResizes()   After shrinking the fullsize, we might need to delete resizes

[ Top ]
Methods
applyLimits  [line 46]

  array applyLimits( &$item, string $operation, array $args, GalleryPhotoItem $item  )

Reduce the item file size without preserving the original

Parameters:
GalleryPhotoItem   $item: 
string   $operation:  ('scale' to reduce dimensions, 'compress' to reduce filesize)
array   $args:  operation arguments to pass through to the toolkit
   &$item: 

API Tags:
Return:  GalleryStatus a status code, array (errors), array (warnings)


[ Top ]
buildDerivativeWithLimits  [line 124]

  array buildDerivativeWithLimits( GalleryPhotoItem $item, string $operation, array $args  )

Set up a preferred derivative that conforms to size limits

Parameters:
GalleryPhotoItem   $item: 
string   $operation:  ('scale' to reduce dimensions, 'compress' to reduce filesize)
array   $args:  passthru to the toolkit

API Tags:
Return:  GalleryStatus a status code, array (errors), array (warnings)


[ Top ]
_updateResizes  [line 215]

  GalleryStatus _updateResizes( int $itemId, int $imageWidth, int $imageHeight  )

After shrinking the fullsize, we might need to delete resizes

Parameters:
int   $itemId: 
int   $imageWidth:  new fullsize width
int   $imageHeight:  new fullsize height

API Tags:
Return:  a status code


[ Top ]

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