Class: ThumbnailImage

Source Location: /modules/thumbnail/classes/ThumbnailImage.class

Class ThumbnailImage

Class Overview

Representation of an image used for thumbnails of non-image items.

Located in /modules/thumbnail/classes/ThumbnailImage.class [line 46]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryChildEntity
         |
         --GalleryFileSystemEntity
            |
            --ThumbnailImage

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryFileSystemEntity

GalleryFileSystemEntity::$pathComponent

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 GalleryFileSystemEntity

GalleryFileSystemEntity::create()

Create a new instance of this FileSystemEntity in the persistent store.

GalleryFileSystemEntity::createLink()

GalleryFileSystemEntity::createRoot()

Create a new root level instance of this FileSystemEntity in the persistent store.

GalleryFileSystemEntity::delete()

Delete this GalleryFileSystemEntity

GalleryFileSystemEntity::fetchContainerPath()

Return a path for any objects contained within this one (ie, children)

GalleryFileSystemEntity::fetchLogicalPath()

Return the logical path to this item. Note that this path is only valid as long as the entire tree is at least read locked.

GalleryFileSystemEntity::fetchPath()

Return the full path of this item. Note that this path is only valid as long as the entire tree is at least read locked.

GalleryFileSystemEntity::getClassName()

GalleryFileSystemEntity::getPathComponent()

GalleryFileSystemEntity::isContainer()

Can this item contain other file system items?

GalleryFileSystemEntity::move()

Move item to a new parent

GalleryFileSystemEntity::rename()

Rename this item

GalleryFileSystemEntity::setPathComponent()

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.
string	$itemMimeTypes	The mime types for which this image is the default thumbnail.
string	$mimeType	The mime type of the image.
int	$size	The size of the image file.
int	$width	The width of the image.

[ Top ]

Method Summary

GalleryStatus	create()	Create a new instance of this type in the persistent store.
void	delete()	Deletes this ThumbnailImage.
void	fetchLogicalPath()
array	fetchPath()	Full path to image file
void	getClassName()
void	getHeight()
void	getItemMimeTypes()
array(string	getItemMimeTypesList()	Get array of item mime types.
void	getMimeType()
void	getRenderer()	So ThumbnailImage is displayable with {g->image}
void	getSize()
string	getThumbnailDir()	Thumbnail directory
void	getWidth()
void	move()
string	render()	Render image
void	save()
void	setHeight()
void	setItemMimeTypes()
void	setItemMimeTypesList()	Set array of item mime types.
void	setMimeType()
void	setSize()
void	setWidth()
GalleryStatus	_restoreItemThumbnails()	Ensure that items / derivatives affected by the deletion of a ThumbnailItem still have a thumbnail after the removal. Restore the sourceId to the original item (if there is toolkit support for that source mimeType). And pick a new highlight for AlbumItems.

[ Top ]

Properties

int $height [line 103]

The height of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>height</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	</member>

[ Top ]

string $itemMimeTypes [line 118]

The mime types for which this image is the default thumbnail.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>itemMimeTypes</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $mimeType [line 61]

The mime type of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>mimeType</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>READ</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

int $size [line 75]

The size of the image file.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>size</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	</member>

[ Top ]

int $width [line 89]

The width of the image.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>width</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	</member>

[ Top ]

Methods

create [line 147]

GalleryStatus create(
string
$inputFileName, string
$mimeType, [string
$targetName = null], [int
$parentId = null] 
)

Create a new instance of this type in the persistent store.

Parameters:

string	$inputFileName:	the path to a data file to be contained
string	$mimeType:	the mime type of the new item
string	$targetName:	(optional) the desired name of the new item.
int	$parentId:	(optional) Id of the parent entity or null. Defaults to null.

API Tags:

Return:

a status code

Redefinition of:

GalleryFileSystemEntity::create(): Create a new instance of this FileSystemEntity in the persistent store.

[ Top ]

delete [line 255]

void delete(
)

Deletes this ThumbnailImage.

API Tags:

See:

GalleryEntity::delete

Redefinition of:

GalleryFileSystemEntity::delete(): Delete this GalleryFileSystemEntity

[ Top ]

fetchLogicalPath [line 432]

void fetchLogicalPath(
)

Redefinition of:

GalleryFileSystemEntity::fetchLogicalPath(): Return the logical path to this item. Note that this path is only valid as long as the entire tree is at least read locked.

[ Top ]

fetchPath [line 412]

array fetchPath(
)

Full path to image file

API Tags:

Return:

GalleryStatus a status code, string path

Redefinition of:

GalleryFileSystemEntity::fetchPath(): Return the full path of this item. Note that this path is only valid as long as the entire tree is at least read locked.

[ Top ]

getClassName [line 525]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryFileSystemEntity::getClassName()

[ Top ]

getHeight [line 553]

void getHeight(
)

[ Top ]

getItemMimeTypes [line 561]

void getItemMimeTypes(
)

[ Top ]

getItemMimeTypesList [line 125]

array(string getItemMimeTypesList(
)

Get array of item mime types.

API Tags:

Return:

mime type)

[ Top ]

getMimeType [line 529]

void getMimeType(
)

[ Top ]

getRenderer [line 518]

void getRenderer(
)

So ThumbnailImage is displayable with {g->image}

Redefinition of:

GalleryEntity::getRenderer()

[ Top ]

getSize [line 537]

void getSize(
)

[ Top ]

getThumbnailDir [line 455]

string getThumbnailDir(
)

Thumbnail directory

API Tags:

Return:

Directory where thumbnail images are stored

[ Top ]

getWidth [line 545]

void getWidth(
)

[ Top ]

move [line 465]

void move(

$newParentId 
)

Parameters:

$newParentId:

API Tags:

See:

GalleryFileSystemEntity::move

Redefinition of:

GalleryFileSystemEntity::move(): Move item to a new parent

[ Top ]

render [line 474]

string render(

$format, 
$params 
)

Render image

Parameters:

	$format:
	$params:

API Tags:

Return:

content

[ Top ]

save [line 246]

void save(
[
$postEvent = true] 
)

Parameters:

$postEvent:

API Tags:

See:

GalleryEntity::save

Redefinition of:

GalleryEntity::save(): Save the changes to this GalleryEntity.

[ Top ]

setHeight [line 557]

void setHeight(

$height 
)

Parameters:

$height:

[ Top ]

setItemMimeTypes [line 565]

void setItemMimeTypes(

$itemMimeTypes 
)

Parameters:

$itemMimeTypes:

[ Top ]

setItemMimeTypesList [line 134]

void setItemMimeTypesList(
array
$mimeTypeList 
)

Set array of item mime types.

Parameters:

array

$mimeTypeList:

array(string mime type, ..)

[ Top ]

setMimeType [line 533]

void setMimeType(

$mimeType 
)

Parameters:

$mimeType:

[ Top ]

setSize [line 541]

void setSize(

$size 
)

Parameters:

$size:

[ Top ]

setWidth [line 549]

void setWidth(

$width 
)

Parameters:

$width:

[ Top ]

_restoreItemThumbnails [line 319]

GalleryStatus _restoreItemThumbnails(
)

Ensure that items / derivatives affected by the deletion of a ThumbnailItem still have a thumbnail after the removal. Restore the sourceId to the original item (if there is toolkit support for that source mimeType). And pick a new highlight for AlbumItems.

API Tags:

Return:

a status code

[ Top ]

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

	Thumbnail Classes

[ class tree: Thumbnail ] [ index: Thumbnail ] [ all elements ]