Class: GalleryItem

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

Class GalleryItem

Class Overview

Abstract base class for all objects in the Gallery composite tree.

Container for all functionality and data common objects that Gallery can deal with. Each GalleryItem has the capacity to own other GalleryItems in a parent-child relationship. That capacity can be enabled or disabled by subclasses of GalleryItem.

Located in /modules/core/classes/GalleryItem.class [line 56]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryChildEntity
         |
         --GalleryFileSystemEntity
            |
            --GalleryItem

Author(s):

API Tags:

Abstract:

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
GalleryDynamicAlbum	A container like GalleryAlbumItem but for a dynamic set of child items.
GalleryDataItem	A subclass of GalleryItem for items containing actual data.
GalleryAlbumItem	A subclass of GalleryItem for containing groups of GalleryItems.
GalleryLinkItem	An extension of GalleryItem to link to another album or an external url.

[ 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

boolean	$canContainChildren	Can this item contain children?
string	$description	The (long) description of this item
string	$keywords	A set of keywords that describe this item
int	$originationTimestamp	Date and time when this item was originally captured (i.e. photographed, filmed, etc)
int	$ownerId	The id of the User who owns this item
string	$renderer	The renderer for drawing this item
string	$summary	The summary of this item
string	$title	The (short) title of this item
int	$viewedSinceTimestamp	Date and time marking the beginning of the view count

[ Top ]

Method Summary

GalleryStatus	create()	Create a new instance of this GalleryEntity in the persistent store.
void	createLink()
GalleryStatus	createRoot()	Create a root level instance of this GalleryEntity in the persistent store.
GalleryStatus	delete()	Delete this GalleryEntity. Delete all of its children also, if it has any.
void	getCanContainChildren()
void	getClassName()
void	getDescription()
void	getKeywords()
void	getOriginationTimestamp()
void	getOwnerId()
void	getRenderer()
void	getSummary()
void	getTitle()
void	getViewedSinceTimestamp()
GalleryStatus	move()	Move item to a new parent
GalleryStatus	save()	Save the changes to this GalleryItem.
void	setCanContainChildren()
void	setDescription()
void	setKeywords()
void	setOriginationTimestamp()
void	setOwnerId()
void	setRenderer()
void	setSummary()
void	setTitle()
void	setViewedSinceTimestamp()

[ Top ]

Properties

boolean $canContainChildren [line 69]

Can this item contain children?

Information Tags:

G2:	<member-name>canContainChildren</member-name>
G2:	<member>
G2:	<member-type>BOOLEAN</member-type>
G2:	<required/>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

string $description [line 82]

The (long) description of this item

Information Tags:

G2:	<member-name>description</member-name>
G2:	<member>
G2:	<member-type>TEXT</member-type>
G2:	<member-size>SMALL</member-size>
G2:	<member-external-access>FULL</member-external-access>
G2:	</member>

[ Top ]

string $keywords [line 96]

A set of keywords that describe this item

Information Tags:

G2:	<member-name>keywords</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>LARGE</member-size>
G2:	<member-external-access>FULL</member-external-access>
G2:	<indexed/>
G2:	</member>

[ Top ]

int $originationTimestamp [line 175]

Date and time when this item was originally captured (i.e. photographed, filmed, etc)

Information Tags:

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

[ Top ]

int $ownerId [line 109]

The id of the User who owns this item

Information Tags:

G2:	<member-name>ownerId</member-name>
G2:	<member>
G2:	<member-type>INTEGER</member-type>
G2:	<indexed/>
G2:	<required/>
G2:	</member>

[ Top ]

string $renderer [line 121]

The renderer for drawing this item

Information Tags:

G2:	<member>
G2:	<member-name>renderer</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $summary [line 135]

The summary of this item

Information Tags:

G2:	<member-name>summary</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>LARGE</member-size>
G2:	<member-external-access>FULL</member-external-access>
G2:	<indexed/>
G2:	</member>

[ Top ]

string $title [line 149]

The (short) title of this item

Information Tags:

G2:	<member-name>title</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	<member-external-access>FULL</member-external-access>
G2:	<indexed/>
G2:	</member>

[ Top ]

int $viewedSinceTimestamp [line 162]

Date and time marking the beginning of the view count

Information Tags:

G2:	<member-name>viewedSinceTimestamp</member-name>
G2:	<member>
G2:	<member-type>INTEGER</member-type>
G2:	<required/>
G2:	<member-external-access>READ</member-external-access>
G2:	</member>

[ Top ]

Methods

create [line 188]

GalleryStatus create(
int
$parentId, string
$path, [boolean
$canContainChildren = false] 
)

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

Let the parent do its work, then add any initialization specific to this class.

Parameters:

int	$parentId:	the id of the GalleryEntity parent of this object
string	$path:	the path component of this new object
boolean	$canContainChildren:	(optional) Used for legal path component characters. Defaults to false.

API Tags:

Return:

a status code

Redefinition of:

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

Redefined in descendants as:

GalleryDynamicAlbum::create() : Initialize dynamic album
GalleryDataItem::create() : Create a new instance of this type in the persistent store.
GalleryAnimationItem::create() : Create a new GalleryAnimationItem from a animation file
GalleryMovieItem::create() : Create a new GalleryMovieItem from a video file
GalleryPhotoItem::create() : Create a new GalleryPhotoItem from an image file
GalleryUnknownItem::create() : Create a new GalleryUnknownItem from an image file
GalleryAlbumItem::create() : Create a new instance of this AlbumItem in the persistent store.
GalleryLinkItem::create() : Create a new instance of this GalleryEntity in the persistent store.

[ Top ]

createLink [line 260]

void createLink(

$entity, 
$parentId 
)

Parameters:

	$entity:
	$parentId:

API Tags:

See:

GalleryEntity::createLink

Redefinition of:

GalleryFileSystemEntity::createLink()

[ Top ]

createRoot [line 237]

GalleryStatus createRoot(
)

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

Let the parent do its work, then add any initialization specific to this class.

API Tags:

Return:

a status code

Redefinition of:

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

Redefined in descendants as:

GalleryAlbumItem::createRoot() : Create a new root level album

[ Top ]

delete [line 301]

GalleryStatus delete(
)

Delete this GalleryEntity. Delete all of its children also, if it has any.

API Tags:

Return:

a status code

Redefinition of:

GalleryFileSystemEntity::delete(): Delete this GalleryFileSystemEntity

Redefined in descendants as:

GalleryDynamicAlbum::delete()
GalleryDataItem::delete() : Delete this GalleryEntity
GalleryAlbumItem::delete() : Delete this AlbumItem.

[ Top ]

getCanContainChildren [line 478]

void getCanContainChildren(
)

[ Top ]

getClassName [line 474]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryFileSystemEntity::getClassName()

Redefined in descendants as:

[ Top ]

getDescription [line 486]

void getDescription(
)

[ Top ]

getKeywords [line 494]

void getKeywords(
)

[ Top ]

getOriginationTimestamp [line 542]

void getOriginationTimestamp(
)

[ Top ]

getOwnerId [line 502]

void getOwnerId(
)

[ Top ]

getRenderer [line 510]

void getRenderer(
)

Redefinition of:

GalleryEntity::getRenderer()

[ Top ]

getSummary [line 518]

void getSummary(
)

[ Top ]

getTitle [line 526]

void getTitle(
)

[ Top ]

getViewedSinceTimestamp [line 534]

void getViewedSinceTimestamp(
)

[ Top ]

move [line 374]

GalleryStatus move(
int
$newParentId 
)

Move item to a new parent

Parameters:

int

$newParentId:

the id of the new parent GalleryItem

API Tags:

Return:

a status code

Redefinition of:

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

Redefined in descendants as:

GalleryDynamicAlbum::move()
GalleryAlbumItem::move() : Move this item to a new parent
GalleryLinkItem::move()

[ Top ]

save [line 408]

GalleryStatus save(
[
$postEvent = true] 
)

Save the changes to this GalleryItem.

Parameters:

$postEvent:

API Tags:

Return:

a status code

Redefinition of:

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

Redefined in descendants as:

[ Top ]

setCanContainChildren [line 482]

void setCanContainChildren(

$canContainChildren 
)

Parameters:

$canContainChildren:

[ Top ]

setDescription [line 490]

void setDescription(

$description 
)

Parameters:

$description:

[ Top ]

setKeywords [line 498]

void setKeywords(

$keywords 
)

Parameters:

$keywords:

[ Top ]

setOriginationTimestamp [line 546]

void setOriginationTimestamp(

$originationTimestamp 
)

Parameters:

$originationTimestamp:

[ Top ]

setOwnerId [line 506]

void setOwnerId(

$ownerId 
)

Parameters:

$ownerId:

[ Top ]

setRenderer [line 514]

void setRenderer(

$renderer 
)

Parameters:

$renderer:

[ Top ]

setSummary [line 522]

void setSummary(

$summary 
)

Parameters:

$summary:

[ Top ]

setTitle [line 530]

void setTitle(

$title 
)

Parameters:

$title:

[ Top ]

setViewedSinceTimestamp [line 538]

void setViewedSinceTimestamp(

$viewedSinceTimestamp 
)

Parameters:

$viewedSinceTimestamp:

[ Top ]

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

	GalleryCore Classes

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