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

Class: GalleryAlbumItem

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

Class GalleryAlbumItem

Class Overview

A subclass of GalleryItem for containing groups of GalleryItems.

A GalleryItem that has certain extra properties relating to displaying item groups and is allowed to contain other GalleryItems.

Located in /modules/core/classes/GalleryAlbumItem.class [line 50]

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

Properties

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   $orderBy   Specify the name of the field that we're using to order children
string   $orderDirection   Specify the order direction that we're applying to the orderBy field
string   $theme   The theme to use for this item

[ Top ]
Method Summary
GalleryStatus   create()   Create a new instance of this AlbumItem in the persistent store.
GalleryStatus   createRoot()   Create a new root level album
GalleryStatus   delete()   Delete this AlbumItem.
void   getClassName()  
void   getOrderBy()  
void   getOrderDirection()  
void   getTheme()  
true   isContainer()   Can this item contain other file system items? Always returns true -- AlbumItems contain other GalleryItems
void   itemTypeName()  
GalleryStatus   move()   Move this item to a new parent
GalleryStatus   rename()   Rename this album
void   save()  
void   setOrderBy()  
void   setOrderDirection()  
void   setTheme()  
void   _createDir()   Internal function to create the album directory

[ Top ]
Properties
string   $orderBy [line 74]

Specify the name of the field that we're using to order children

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

[ Top ]
string   $orderDirection [line 86]

Specify the order direction that we're applying to the orderBy field

Information Tags:
G2:  <member>
G2:  <member-name>orderDirection</member-name>
G2:  <member-type>STRING</member-type>
G2:  <member-size>SMALL</member-size>
G2:  </member>

[ Top ]
string   $theme [line 62]

The theme to use for this item

Information Tags:
G2:  <member>
G2:  <member-name>theme</member-name>
G2:  <member-type>STRING</member-type>
G2:  <member-size>SMALL</member-size>
G2:  </member>

[ Top ]
Methods
create  [line 96]

  GalleryStatus create( int $parentId, $albumName  )

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

Also create the album directory on the filesystem.

Parameters:
int   $parentId:  the id of the parent of this object
   $albumName: 

API Tags:
Return:  a status code


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

[ Top ]
createRoot  [line 175]

  GalleryStatus createRoot( )

Create a new root level album


API Tags:
Return:  a status code


Redefinition of:
GalleryItem::createRoot()
Create a root level instance of this GalleryEntity in the persistent store.

[ Top ]
delete  [line 298]

  GalleryStatus delete( )

Delete this AlbumItem.

Delete all children and then remove the album directory.


API Tags:
Return:  a status code


Redefinition of:
GalleryItem::delete()
Delete this GalleryEntity. Delete all of its children also, if it has any.

[ Top ]
getClassName  [line 472]

  void getClassName( )


API Tags:
See:  GalleryEntity::getClassName


Redefinition of:
GalleryItem::getClassName()

[ Top ]
getOrderBy  [line 484]

  void getOrderBy( )



[ Top ]
getOrderDirection  [line 492]

  void getOrderDirection( )



[ Top ]
getTheme  [line 476]

  void getTheme( )



[ Top ]
isContainer  [line 252]

  true isContainer( )

Can this item contain other file system items? Always returns true -- AlbumItems contain other GalleryItems


API Tags:
Return:  if this item can contain other file system items


Redefinition of:
GalleryFileSystemEntity::isContainer()
Can this item contain other file system items?

[ Top ]
itemTypeName  [line 458]

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

  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


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

[ Top ]
rename  [line 343]

  GalleryStatus rename( string $newName  )

Rename this album

Parameters:
string   $newName:  the path component

API Tags:
Return:  a status code


Redefinition of:
GalleryFileSystemEntity::rename()
Rename this item

[ Top ]
save  [line 259]

  void save( [ $postEvent = true]  )

Parameters:
   $postEvent: 

API Tags:
See:  GalleryItem::save()


Redefinition of:
GalleryItem::save()
Save the changes to this GalleryItem.

[ Top ]
setOrderBy  [line 488]

  void setOrderBy( $orderBy  )

Parameters:
   $orderBy: 


[ Top ]
setOrderDirection  [line 496]

  void setOrderDirection( $orderDirection  )

Parameters:
   $orderDirection: 


[ Top ]
setTheme  [line 480]

  void setTheme( $theme  )

Parameters:
   $theme: 


[ Top ]
_createDir  [line 223]

  void _createDir( $albumDir  )

Internal function to create the album directory

Parameters:
   $albumDir: 

API Tags:
Access:  private


[ Top ]

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