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

Class: GalleryItemHelper_medium

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

Class GalleryItemHelper_medium

Method Summary
void   addExistingItemToAlbum()  
void   addItemToAlbum()  
void   applyDerivativePreferences()  
void   fetchAllItemIds()  
void   fetchAllItemIdsByOwnerId()  
void   fetchOriginationTimestamp()  
void   handleEvent()   Handler for Gallery::ViewableTreeChange event.
GalleryStatus   invalidateDescendentCountCaches()   Invalidate our descendent count cache, any time we make a change that
void   newItemByMimeType()  
void   setThumbnailFromItem()  

[ Top ]
Methods
addExistingItemToAlbum  [line 238]

  void addExistingItemToAlbum( $item, $albumId, [ $isNew = false]  )

Parameters:
   $item: 
   $albumId: 
   $isNew: 

API Tags:
See:  GalleryCoreApi::addExistingItemToAlbum


[ Top ]
addItemToAlbum  [line 141]

  void addItemToAlbum( $fileName, $itemName, $title, $summary, $description, $mimeType, $albumId, [ $symlink = false]  )

Parameters:
   $fileName: 
   $itemName: 
   $title: 
   $summary: 
   $description: 
   $mimeType: 
   $albumId: 
   $symlink: 

API Tags:
See:  GalleryCoreApi::addItemToAlbum


[ Top ]
applyDerivativePreferences  [line 261]

  void applyDerivativePreferences( $item, $albumId, [ $isNew = false]  )

Parameters:
   $item: 
   $albumId: 
   $isNew: 

API Tags:
See:  GalleryCoreApi::applyDerivativePreferences


[ Top ]
fetchAllItemIds  [line 40]

  void fetchAllItemIds( $itemType, [ $permission = 'core.view']  )

Parameters:
   $itemType: 
   $permission: 

API Tags:
See:  GalleryCoreApi::fetchAllItemIds


[ Top ]
fetchAllItemIdsByOwnerId  [line 93]

  void fetchAllItemIdsByOwnerId( $ownerId  )

Parameters:
   $ownerId: 

API Tags:
See:  GalleryCoreApi::fetchAllItemIdsByOwnerId


[ Top ]
fetchOriginationTimestamp  [line 205]

  void fetchOriginationTimestamp( $item  )

Parameters:
   $item: 

API Tags:
See:  GalleryCoreApi::fetchOriginationTimestamp


[ Top ]
handleEvent  [line 875]

  void handleEvent( $event  )

Handler for Gallery::ViewableTreeChange event.

Event sends array('userId'=>id or array of ids or null, 'itemId'=>id or array of ids or null)

Parameters:
   $event: 

API Tags:
See:  GalleryEventListener::handleEvent


[ Top ]
invalidateDescendentCountCaches  [line 821]

  GalleryStatus invalidateDescendentCountCaches( mixed $userId, mixed $itemId  )

Invalidate our descendent count cache, any time we make a change that

would possibly affect any of our counts:

  • adding a new item
  • deleting an item
  • moving an item
  • changing view permissions on an item
  • adding a user to a group
  • removing a user from a group

If you provide just a user id, it will invalidate all cached values for that user. If you provide just an item id, it'll invalidate that id and all of its parents for all users. If you provide both, it will only invalidate for the intersection of the user and the item ids.

Parameters:
mixed   $userId:  user id or array of ids or null
mixed   $itemId:  item id or array of ids or null

API Tags:
Return:  a status code


[ Top ]
newItemByMimeType  [line 126]

  void newItemByMimeType( $mimeType  )

Parameters:
   $mimeType: 

API Tags:
See:  GalleryCoreApi::newItemByMimeType


[ Top ]
setThumbnailFromItem  [line 550]

  void setThumbnailFromItem( $itemId, $fromItemId  )

Parameters:
   $itemId: 
   $fromItemId: 

API Tags:
See:  GalleryCoreApi::setThumbnailFromItem


[ Top ]

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