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

Class: GalleryDerivativeImage

Source Location: /modules/core/classes/GalleryDerivativeImage.class

Class GalleryDerivativeImage

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryDerivative

GalleryDerivative::$derivativeOperations
GalleryDerivative::$derivativeOrder
GalleryDerivative::$derivativeSize
GalleryDerivative::$derivativeSourceId
GalleryDerivative::$derivativeType
GalleryDerivative::$isBroken
GalleryDerivative::$mimeType
GalleryDerivative::$postFilterOperations

Inherited From GalleryChildEntity

GalleryChildEntity::$parentId

Inherited From GalleryEntity

GalleryEntity::$creationTimestamp
GalleryEntity::$entityType
GalleryEntity::$id
GalleryEntity::$isLinkable
GalleryEntity::$linkedEntity
GalleryEntity::$linkId
GalleryEntity::$modificationTimestamp
GalleryEntity::$onLoadHandlers
GalleryEntity::$serialNumber

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

Inherited From GalleryDerivative

GalleryDerivative::canBeViewedInline()
Data items that can be viewed inline (photos, movies, etc) should return true. Items that can't be viewed inline (word documents, text, etc) should return false.
GalleryDerivative::create()
Create a new GalleryDerivative
GalleryDerivative::delete()
Delete this GalleryEntity
GalleryDerivative::expireCache()
Expire the cache.
GalleryDerivative::fetchFinalOperations()
Get the complete set of operations required by this derivative. This will return the original source GalleryDataItem or preferred GalleryDerivative and an array of all the operations that must be performed in order to create the correct output file, including the post filter.
GalleryDerivative::fetchPath()
Get the full path to the data file.
GalleryDerivative::getBrokenDerivativePath()
Return path for broken derivative placeholder which is shown when we fail to generate a derivative item. Descendent classes can override this method to use their own broken derivative placeholder, which can be of any mime type, eg. a wav file for broken audio derivatives, etc.
GalleryDerivative::getClassName()
GalleryDerivative::getDerivativeOperations()
GalleryDerivative::getDerivativeOrder()
GalleryDerivative::getDerivativeSize()
GalleryDerivative::getDerivativeSourceId()
GalleryDerivative::getDerivativeType()
GalleryDerivative::getIsBroken()
GalleryDerivative::getMimeType()
GalleryDerivative::getPostFilterOperations()
GalleryDerivative::hasNoOperations()
Return true if we have no derivative or postfilter operations
GalleryDerivative::isCacheCurrent()
Is the cache for this item still current? If the cache is expired, it can be rebuilt with rebuildCache()
GalleryDerivative::rebuildCache()
Rebuild the cache. This should never be called directly; instead you should call GalleryCoreApi::rebuildDerivativeCacheIfNotCurrent($derivativeId)
GalleryDerivative::render()
Render this item in the given format. For example, GalleryDerivativeImage may want to render as an <img> tag in the HTML format.
GalleryDerivative::save()
GalleryDerivative::setDerivativeOperations()
GalleryDerivative::setDerivativeOrder()
GalleryDerivative::setDerivativeSize()
GalleryDerivative::setDerivativeSourceId()
GalleryDerivative::setDerivativeType()
GalleryDerivative::setIsBroken()
GalleryDerivative::setMimeType()
GalleryDerivative::setPostFilterOperations()
GalleryDerivative::_rebuildCache()
Rebuild the cache. This should never be called directly; instead you should call GalleryCoreApi::rebuildDerivativeCacheIfNotCurrent($derivativeId)

Inherited From GalleryChildEntity

GalleryChildEntity::create()
Create this item in our persistent store
GalleryChildEntity::createLink()
GalleryChildEntity::createRoot()
Create a root level item.
GalleryChildEntity::fetchParent()
Get the parent instance
GalleryChildEntity::getClassName()
GalleryChildEntity::getParentId()
GalleryChildEntity::move()
Move this item to a new parent
GalleryChildEntity::setParentId()

Inherited From GalleryEntity

GalleryEntity::addOnLoadHandler()
Add onLoad handler.
GalleryEntity::create()
Create a new instance of this GalleryEntity in the persistent store
GalleryEntity::createLink()
Create a new linked version of this item into a new album
GalleryEntity::delete()
Delete this GalleryEntity
GalleryEntity::detachLink()
Detach this entity from the entity it is linked to by the simple expedient of overwriting over all non-null members with the equivalent from the link target.
GalleryEntity::getClassName()
Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.
GalleryEntity::getCreationTimestamp()
GalleryEntity::getEntityType()
GalleryEntity::getId()
GalleryEntity::getIsLinkable()
GalleryEntity::getLinkedEntity()
GalleryEntity::getLinkId()
GalleryEntity::getModificationTimestamp()
GalleryEntity::getOnLoadHandlers()
GalleryEntity::getRenderer()
GalleryEntity::getSerialNumber()
GalleryEntity::hasOnLoadHandler()
Check for an onLoad handler.
GalleryEntity::isLinked()
Return true if this entity is linked to another
GalleryEntity::itemTypeName()
Return the name of this type of item.
GalleryEntity::onLoad()
This is called after an entity is loaded by the GalleryStorage subsystem.
GalleryEntity::onSave()
This is called after an entity is saved by the GalleryStorage subsystem.
GalleryEntity::refresh()
Refresh this item from the persistent store
GalleryEntity::removeOnLoadHandler()
Remove onLoad handler.
GalleryEntity::save()
Save the changes to this GalleryEntity.
GalleryEntity::setCreationTimestamp()
GalleryEntity::setEntityType()
GalleryEntity::setId()
GalleryEntity::setIsLinkable()
GalleryEntity::setLinkedEntity()
GalleryEntity::setLinkId()
GalleryEntity::setModificationTimestamp()
GalleryEntity::setOnLoadHandlers()
GalleryEntity::setSerialNumber()

Inherited From GalleryPersistent

GalleryPersistent::GalleryPersistent()
GalleryPersistent::clearPersistentFlag()
Clear a flag.
GalleryPersistent::getClassFile()
Return the relative path to the class for this entity
GalleryPersistent::getOriginalValue()
Return the original value of the given member.
GalleryPersistent::isModified()
Have we modified any data in this class?
GalleryPersistent::resetOriginalValues()
Reset all original values to the current values in the entity (or null if so specified).
GalleryPersistent::setPersistentFlag()
Set a flag.
GalleryPersistent::testPersistentFlag()
Test a flag.

[ Top ]
Property Summary
int   $height   The height of the image.
int   $width   The width of the image.

[ Top ]
Method Summary
void   canBeViewedInline()  
GalleryStatus   create()   Create a new GalleryDerivativeImage
void   getClassName()  
void   getHeight()  
void   getWidth()  
GalleryStatus   rebuildCache()   Rebuild the cache.
void   render()  
void   setHeight()  
void   setWidth()  

[ Top ]
Properties
int   $height [line 72]

The height of the image.

Information Tags:
G2:  <member>
G2:  <member-name>height</member-name>
G2:  <member-type>INTEGER</member-type>
G2:  <member-external-access>READ</member-external-access>
G2:  </member>

[ Top ]
int   $width [line 60]

The width of the image.

Information Tags:
G2:  <member>
G2:  <member-name>width</member-name>
G2:  <member-type>INTEGER</member-type>
G2:  <member-external-access>READ</member-external-access>
G2:  </member>

[ Top ]
Methods
canBeViewedInline  [line 78]

  void canBeViewedInline( )


API Tags:
See:  GalleryDerivative::canBeViewedInline


Redefinition of:
GalleryDerivative::canBeViewedInline()
Data items that can be viewed inline (photos, movies, etc) should return true. Items that can't be viewed inline (word documents, text, etc) should return false.

[ Top ]
create  [line 89]

  GalleryStatus create( int $parentId, int $derivativeType  )

Create a new GalleryDerivativeImage

Parameters:
int   $parentId:  the id of the parent GalleryItem
int   $derivativeType:  the type of derivative image

API Tags:
Return:  a status code


Redefinition of:
GalleryDerivative::create()
Create a new GalleryDerivative

[ Top ]
getClassName  [line 238]

  void getClassName( )


API Tags:
See:  GalleryEntity::getClassName


Redefinition of:
GalleryDerivative::getClassName()

[ Top ]
getHeight  [line 250]

  void getHeight( )



[ Top ]
getWidth  [line 242]

  void getWidth( )



[ Top ]
rebuildCache  [line 152]

  GalleryStatus rebuildCache( )

Rebuild the cache.

Break apart the derivative commands and feed them into the appropriate graphics toolkits to perform the transformation necessary to create this derivative from its source.


API Tags:
Return:  a status code


Redefinition of:
GalleryDerivative::rebuildCache()
Rebuild the cache. This should never be called directly; instead you should call GalleryCoreApi::rebuildDerivativeCacheIfNotCurrent($derivativeId)

[ Top ]
render  [line 189]

  void render( $format, $item, $params  )

Parameters:
   $format: 
   $item: 
   $params: 

API Tags:
See:  GalleryDerivative::render


Redefinition of:
GalleryDerivative::render()
Render this item in the given format. For example, GalleryDerivativeImage may want to render as an <img> tag in the HTML format.

[ Top ]
setHeight  [line 254]

  void setHeight( $height  )

Parameters:
   $height: 


[ Top ]
setWidth  [line 246]

  void setWidth( $width  )

Parameters:
   $width: 


[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:58:03 -0700 by phpDocumentor 1.3.0RC6