Class: GalleryLinkItem

Source Location: /modules/linkitem/classes/GalleryLinkItem.class

Class GalleryLinkItem

Class Overview

An extension of GalleryItem to link to another album or an external url.

Located in /modules/linkitem/classes/GalleryLinkItem.class [line 46]

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

Properties

$link

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryItem

GalleryItem::$canContainChildren

GalleryItem::$description

GalleryItem::$keywords

GalleryItem::$originationTimestamp

GalleryItem::$ownerId

GalleryItem::$renderer

GalleryItem::$summary

GalleryItem::$title

GalleryItem::$viewedSinceTimestamp

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 GalleryItem

GalleryItem::create()

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

GalleryItem::createLink()

GalleryItem::createRoot()

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

GalleryItem::delete()

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

GalleryItem::getCanContainChildren()

GalleryItem::getClassName()

GalleryItem::getDescription()

GalleryItem::getKeywords()

GalleryItem::getOriginationTimestamp()

GalleryItem::getOwnerId()

GalleryItem::getRenderer()

GalleryItem::getSummary()

GalleryItem::getTitle()

GalleryItem::getViewedSinceTimestamp()

GalleryItem::move()

Move item to a new parent

GalleryItem::save()

Save the changes to this GalleryItem.

GalleryItem::setCanContainChildren()

GalleryItem::setDescription()

GalleryItem::setKeywords()

GalleryItem::setOriginationTimestamp()

GalleryItem::setOwnerId()

GalleryItem::setRenderer()

GalleryItem::setSummary()

GalleryItem::setTitle()

GalleryItem::setViewedSinceTimestamp()

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

string

$link

The id of the linked album or text of external link.

[ Top ]

Method Summary

GalleryStatus	create()	Create a new instance of this GalleryEntity in the persistent store.
void	fetchPath()
void	getClassName()
void	getHeight()
void	getLink()
void	getMimeType()
void	getWidth()
void	itemTypeName()
void	move()
void	onLoad()
void	setLink()

[ Top ]

Properties

string $link [line 62]

The id of the linked album or text of external link.

API Tags:

Access:

public

Information Tags:

G2:	<member-name>link</member-name>
G2:	<member>
G2:	<member-type>TEXT</member-type>
G2:	<member-size>SMALL</member-size>
G2:	<member-external-access>READ</member-external-access>
G2:	<required/>
G2:	</member>

[ Top ]

Methods

create [line 72]

GalleryStatus create(
int
$parentId, mixed
$link 
)

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 parent object
mixed	$link:	the link target: either string url or int id of a GalleryAlbumItem

API Tags:

Return:

a status code

Redefinition of:

GalleryItem::create(): Create a new instance of this GalleryEntity in the persistent store.

[ Top ]

fetchPath [line 170]

void fetchPath(
)

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 186]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryItem::getClassName()

[ Top ]

getHeight [line 179]

void getHeight(
)

[ Top ]

getLink [line 190]

void getLink(
)

[ Top ]

getMimeType [line 173]

void getMimeType(
)

[ Top ]

getWidth [line 176]

void getWidth(
)

[ Top ]

itemTypeName [line 124]

void itemTypeName(
[
$localized = true] 
)

Parameters:

$localized:

API Tags:

See:

GalleryEntity::itemTypeName

Redefinition of:

GalleryEntity::itemTypeName(): Return the name of this type of item.

[ Top ]

move [line 105]

void move(

$newParentId 
)

Parameters:

$newParentId:

API Tags:

See:

GalleryFileSystemEntity::move

Redefinition of:

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

[ Top ]

onLoad [line 137]

void onLoad(
)

API Tags:

See:

GalleryEntity::onLoad

Redefinition of:

GalleryEntity::onLoad(): This is called after an entity is loaded by the GalleryStorage subsystem.

[ Top ]

setLink [line 194]

void setLink(

$link 
)

Parameters:

$link:

[ Top ]

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

	LinkItem Classes

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