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

Class: GalleryMovieItem

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

Class GalleryMovieItem

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryDataItem

GalleryDataItem::$mimeType
GalleryDataItem::$size

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 GalleryDataItem

GalleryDataItem::canBeViewedInline()
Data items that can be viewed inline (photos, movies, etc) should return true.
GalleryDataItem::create()
Create a new instance of this type in the persistent store.
GalleryDataItem::delete()
Delete this GalleryEntity
GalleryDataItem::detachLink()
GalleryDataItem::fetchPath()
Get the full path to the data file.
GalleryDataItem::getClassName()
GalleryDataItem::getMimeType()
GalleryDataItem::getSize()
GalleryDataItem::rename()
Rename this DataItem
GalleryDataItem::render()
GalleryDataItem::rescan()
Scan this item's data for changes.
GalleryDataItem::setMimeType()
GalleryDataItem::setSize()
GalleryDataItem::_canBeViewedInline()
Helper function to check renderer and list of mime types for canBeViewedInline.

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
int   $duration   The duration of the movie in seconds
int   $height   The height of this movie.
int   $width   The width of this movie.

[ Top ]
Method Summary
void   canBeViewedInline()  
GalleryStatus   create()   Create a new GalleryMovieItem from a video file
void   getClassName()  
void   getDuration()  
void   getHeight()  
void   getWidth()  
void   itemTypeName()  
void   render()  
void   rescan()  
void   setDuration()  
void   setHeight()  
void   setWidth()  

[ Top ]
Properties
int   $duration [line 87]

The duration of the movie in seconds

Information Tags:
G2:  <member-name>duration</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <linked/>
G2:  <member-external-access>FULL</member-external-access>
G2:  </member>

[ Top ]
int   $height [line 74]

The height of this movie.

Information Tags:
G2:  <member-name>height</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <linked/>
G2:  <member-external-access>FULL</member-external-access>
G2:  </member>

[ Top ]
int   $width [line 61]

The width of this movie.

Information Tags:
G2:  <member-name>width</member-name>
G2:  <member>
G2:  <member-type>INTEGER</member-type>
G2:  <linked/>
G2:  <member-external-access>FULL</member-external-access>
G2:  </member>

[ Top ]
Methods
canBeViewedInline  [line 93]

  void canBeViewedInline( )


API Tags:
See:  GalleryDataItem::canBeViewedInline


Redefinition of:
GalleryDataItem::canBeViewedInline()
Data items that can be viewed inline (photos, movies, etc) should return true.

[ Top ]
create  [line 119]

  GalleryStatus create( int $parentId, string $videoFileName, string $mimeType, [string $targetName = null], [boolean $symlink = false]  )

Create a new GalleryMovieItem from a video file

Parameters:
int   $parentId:  the id of the parent GalleryItem
string   $videoFileName:  the path to the source video
string   $mimeType: 
string   $targetName:  the desired name of the new item
boolean   $symlink:  (optional) a boolean true if we should symlink instead of copy (default is false).

API Tags:
Return:  a status code


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

[ Top ]
getClassName  [line 309]

  void getClassName( )


API Tags:
See:  GalleryEntity::getClassName


Redefinition of:
GalleryDataItem::getClassName()

Redefined in descendants as:

[ Top ]
getDuration  [line 329]

  void getDuration( )



[ Top ]
getHeight  [line 321]

  void getHeight( )



[ Top ]
getWidth  [line 313]

  void getWidth( )



[ Top ]
itemTypeName  [line 214]

  void itemTypeName( [ $localized = true]  )

Parameters:
   $localized: 

API Tags:
See:  GalleryEntity::itemTypeName


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

[ Top ]
render  [line 228]

  void render( $format, $params  )

Parameters:
   $format: 
   $params: 

API Tags:
See:  GalleryDataItem::render


Redefinition of:
GalleryDataItem::render()

[ Top ]
rescan  [line 163]

  void rescan( )


API Tags:
See:  GalleryDataItem::rescan


Redefinition of:
GalleryDataItem::rescan()
Scan this item's data for changes.

[ Top ]
setDuration  [line 333]

  void setDuration( $duration  )

Parameters:
   $duration: 


[ Top ]
setHeight  [line 325]

  void setHeight( $height  )

Parameters:
   $height: 


[ Top ]
setWidth  [line 317]

  void setWidth( $width  )

Parameters:
   $width: 


[ Top ]

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