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

Class: GalleryEntity

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

Class GalleryEntity

Direct descendents
Child Class Description
GalleryPendingUser Representation of a single pending self-registered user (not yet a valid GalleryUser).
WatermarkImage Representation of an image used for watermarking
GalleryChildEntity An entity that can be the child of another entity.
GalleryGroup Representation of a group of users
GalleryUser Representation of a single user.
EntityTestEntity
ModuleTestEntity
DownloadItemTestEntity

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

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

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   $creationTimestamp   Date and time this item was created, in seconds since the epoch.
string   $entityType   The actual type of this object. This will allow the storage class to correctly load this object from the database.
int   $id   The id of this item
boolean   $isLinkable   Does this entity type support linking?
GalleryEntity   $linkedEntity   The target entity this entity is linked to
int   $linkId   The id of the target entity this entity is linked to
int   $modificationTimestamp   Date and time this item was last modified, in seconds since the epoch.
string   $onLoadHandlers   Handlers to run when this entity is loaded.
int   $serialNumber   The serial number of this object in the persistent store. This value will help us to avoid collisions.

[ Top ]
Method Summary
void   addOnLoadHandler()   Add onLoad handler.
GalleryStatus   create()   Create a new instance of this GalleryEntity in the persistent store
array   createLink()   Create a new linked version of this item into a new album
GalleryStatus   delete()   Delete this GalleryEntity
GalleryStatus   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.
string   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.
void   getCreationTimestamp()  
void   getEntityType()  
void   getId()  
void   getIsLinkable()  
void   getLinkedEntity()  
void   getLinkId()  
void   getModificationTimestamp()  
void   getOnLoadHandlers()  
void   getRenderer()  
void   getSerialNumber()  
boolean   hasOnLoadHandler()   Check for an onLoad handler.
boolean   isLinked()   Return true if this entity is linked to another
array   itemTypeName()   Return the name of this type of item.
GalleryStatus   onLoad()   This is called after an entity is loaded by the GalleryStorage subsystem.
GalleryStatus   onSave()   This is called after an entity is saved by the GalleryStorage subsystem.
array   refresh()   Refresh this item from the persistent store
void   removeOnLoadHandler()   Remove onLoad handler.
GalleryStatus   save()   Save the changes to this GalleryEntity.
void   setCreationTimestamp()  
void   setEntityType()  
void   setId()  
void   setIsLinkable()  
void   setLinkedEntity()  
void   setLinkId()  
void   setModificationTimestamp()  
void   setOnLoadHandlers()  
void   setSerialNumber()  

[ Top ]
Properties
int   $creationTimestamp [line 77]

Date and time this item was created, in seconds since the epoch.

Information Tags:
G2:  <member-name>creationTimestamp</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <indexed/>
G2:  <member-external-access>FULL</member-external-access>
G2:  <required/>
G2:  </member>

[ Top ]
string   $entityType [line 152]

The actual type of this object. This will allow the storage class to correctly load this object from the database.

Information Tags:
G2:  <member-name>entityType</member-name>
G2:  <member>
G2:  <member-type>STRING</member-type>
G2:  <member-size>SMALL</member-size>
G2:  <member-external-access>READ</member-external-access>
G2:  <required/>
G2:  </member>

[ Top ]
int   $id [line 63]

The id of this item

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

[ Top ]
boolean   $isLinkable [line 90]

Does this entity type support linking?

Information Tags:
G2:  <member-name>isLinkable</member-name>
G2:  <member>
G2:  <member-type>BOOLEAN</member-type>
G2:  <indexed/>
G2:  <required/>
G2:  </member>

[ Top ]
GalleryEntity   $linkedEntity [line 108]

The target entity this entity is linked to


[ Top ]
int   $linkId [line 102]

The id of the target entity this entity is linked to

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

[ Top ]
int   $modificationTimestamp [line 122]

Date and time this item was last modified, in seconds since the epoch.

Information Tags:
G2:  <member-name>modificationTimestamp</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <indexed/>
G2:  <member-external-access>READ</member-external-access>
G2:  <required/>
G2:  </member>

[ Top ]
string   $onLoadHandlers [line 164]

Handlers to run when this entity is loaded.

Information Tags:
G2:  <member>
G2:  <member-name>onLoadHandlers</member-name>
G2:  <member-type>STRING</member-type>
G2:  <member-size>MEDIUM</member-size>
G2:  </member>

[ Top ]
int   $serialNumber [line 137]

The serial number of this object in the persistent store. This value will help us to avoid collisions.

Information Tags:
G2:  <member-name>serialNumber</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <indexed/>
G2:  <member-external-access>READ</member-external-access>
G2:  <required/>
G2:  </member>

[ Top ]
Methods
addOnLoadHandler  [line 504]

  void addOnLoadHandler( string $handlerId  )

Add onLoad handler.

Parameters:
string   $handlerId: 


[ Top ]
create  [line 172]

  GalleryStatus create( )

Create a new instance of this GalleryEntity in the persistent store


API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
createLink  [line 226]

  array createLink( GalleryEntity $entity  )

Create a new linked version of this item into a new album

Parameters:
GalleryEntity   $entity:  the entity we're linking to

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


Redefined in descendants as:

[ Top ]
delete  [line 365]

  GalleryStatus delete( )

Delete this GalleryEntity


API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
detachLink  [line 564]

  GalleryStatus 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.


API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
getCreationTimestamp  [line 609]

  void getCreationTimestamp( )



[ Top ]
getEntityType  [line 657]

  void getEntityType( )



[ Top ]
getId  [line 601]

  void getId( )



[ Top ]
getIsLinkable  [line 617]

  void getIsLinkable( )



[ Top ]
getLinkedEntity  [line 633]

  void getLinkedEntity( )



[ Top ]
getLinkId  [line 625]

  void getLinkId( )



[ Top ]
getModificationTimestamp  [line 641]

  void getModificationTimestamp( )



[ Top ]
getOnLoadHandlers  [line 665]

  void getOnLoadHandlers( )



[ Top ]
getRenderer  [line 676]

  void getRenderer( )


Information Tags:
Todo:  Consider removing this method when refactoring the renderer code.

Redefined in descendants as:

[ Top ]
getSerialNumber  [line 649]

  void getSerialNumber( )



[ Top ]
hasOnLoadHandler  [line 495]

  boolean hasOnLoadHandler( string $handlerId  )

Check for an onLoad handler.

Parameters:
string   $handlerId: 


[ Top ]
isLinked  [line 553]

  boolean isLinked( )

Return true if this entity is linked to another



[ Top ]
itemTypeName  [line 545]

  array itemTypeName( [boolean $localized = true]  )

Return the name of this type of item.

Subclasses must override this to provide their own type names.

Parameters:
boolean   $localized:  if the name is to be translated using the current language

API Tags:
Return:  string to be used by itself ("Photo") string to be used in context ("photo")


Redefined in descendants as:

[ Top ]
onLoad  [line 409]

  GalleryStatus onLoad( )

This is called after an entity is loaded by the GalleryStorage subsystem.

Perform any actions that are required after loading the entity.


API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
onSave  [line 533]

  GalleryStatus onSave( )

This is called after an entity is saved by the GalleryStorage subsystem.

Perform any actions that are required after saving the entity.


API Tags:
Return:  a status code


[ Top ]
refresh  [line 340]

  array refresh( )

Refresh this item from the persistent store


API Tags:
Return:  GalleryStatus a status code, object the refreshed GalleryEntity


Redefined in descendants as:

[ Top ]
removeOnLoadHandler  [line 517]

  void removeOnLoadHandler( string $handlerId  )

Remove onLoad handler.

Parameters:
string   $handlerId: 


[ Top ]
save  [line 266]

  GalleryStatus save( [bool $postEvent = true], [int $setAclId = null]  )

Save the changes to this GalleryEntity.

Parameters:
bool   $postEvent:  post a save event; only disable this during core upgrades
int   $setAclId:  (optional) ACL id to assign for new entity (used by subclasses)

API Tags:
Return:  a status code


Redefined in descendants as:

[ Top ]
setCreationTimestamp  [line 613]

  void setCreationTimestamp( $creationTimestamp  )

Parameters:
   $creationTimestamp: 


[ Top ]
setEntityType  [line 661]

  void setEntityType( $entityType  )

Parameters:
   $entityType: 


[ Top ]
setId  [line 605]

  void setId( $id  )

Parameters:
   $id: 


[ Top ]
setIsLinkable  [line 621]

  void setIsLinkable( $isLinkable  )

Parameters:
   $isLinkable: 


[ Top ]
setLinkedEntity  [line 637]

  void setLinkedEntity( $linkedEntity  )

Parameters:
   $linkedEntity: 


[ Top ]
setLinkId  [line 629]

  void setLinkId( $linkId  )

Parameters:
   $linkId: 


[ Top ]
setModificationTimestamp  [line 645]

  void setModificationTimestamp( $modificationTimestamp  )

Parameters:
   $modificationTimestamp: 


[ Top ]
setOnLoadHandlers  [line 669]

  void setOnLoadHandlers( $onLoadHandlers  )

Parameters:
   $onLoadHandlers: 


[ Top ]
setSerialNumber  [line 653]

  void setSerialNumber( $serialNumber  )

Parameters:
   $serialNumber: 


[ Top ]

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