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

Class: GalleryChildEntity

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

Class GalleryChildEntity

Class Overview

An entity that can be the child of another entity.

This object performs all of the basic functions required in all Gallery objects.

Located in /modules/core/classes/GalleryChildEntity.class [line 48]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryChildEntity

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
GalleryFileSystemEntity A GalleryChildEntity that also has data stored in the filesystem.
GalleryDerivative A container for data that is derived from another data source.
DownloadItemTestChildEntity
GalleryComment A GalleryEntity for comments.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

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 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   $parentId   The id of the parent of this GalleryChildEntity

[ Top ]
Method Summary
GalleryStatus   create()   Create this item in our persistent store
void   createLink()  
void   createRoot()   Create a root level item.
array   fetchParent()   Get the parent instance
void   getClassName()  
void   getParentId()  
GalleryStatus   move()   Move this item to a new parent
void   setParentId()  

[ Top ]
Properties
int   $parentId [line 61]

The id of the parent of this GalleryChildEntity

Information Tags:
G2:  <member-name>parentId</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <indexed/>
G2:  <required/>
G2:  </member>

[ Top ]
Methods
create  [line 70]

  GalleryStatus create( int $parentId  )

Create this item in our persistent store

Parameters:
int   $parentId:  the id of the GalleryItem parent

API Tags:
Return:  a status code


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

Redefined in descendants as:

[ Top ]
createLink  [line 91]

  void createLink( $entity, $parentId  )

Parameters:
   $entity: 
   $parentId: 

API Tags:
See:  GalleryEntity::createLink


Redefinition of:
GalleryEntity::createLink()
Create a new linked version of this item into a new album

Redefined in descendants as:

[ Top ]
createRoot  [line 129]

  void createRoot( )

Create a root level item.

This is a special case; every other GalleryChildEntry will have a parent. But the root items don't have one.



Redefined in descendants as:

[ Top ]
fetchParent  [line 147]

  array fetchParent( )

Get the parent instance


API Tags:
Return:  GalleryStatus a status code GalleryItem the parent item


[ Top ]
getParentId  [line 171]

  void getParentId( )



[ Top ]
move  [line 111]

  GalleryStatus move( int $newParentId  )

Move this item to a new parent

Parameters:
int   $newParentId:  the id of the GalleryItem parent

API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
setParentId  [line 175]

  void setParentId( $parentId  )

Parameters:
   $parentId: 


[ Top ]

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