[ Index ]
 

Code source de LifeType 1.2.4

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/class/gallery/dao/ -> galleryresource.class.php (sommaire)

(pas de description)

Poids: 560 lignes (16 kb)
Inclus ou requis:0 fois
Référencé: 1 fois
Nécessite: 0 fichiers

Définit 1 class

GalleryResource:: (40 méthodes):
  GalleryResource()
  getId()
  getOwnerId()
  getBlogInfo()
  getAlbumId()
  getDate()
  getTimestamp()
  getMetadata()
  setMetadata()
  getFlags()
  getFilePath()
  getFileName()
  getEncodedFileName()
  getDescription()
  getMimeType()
  getThumbnailMimeType()
  getResourceType()
  setAlbumId()
  setAlbum()
  getAlbum()
  setDescription()
  getThumbnailFormat()
  setThumbnailFormat()
  getFileSize()
  setFileSize()
  getMetadataReader()
  hasPreview()
  getPreviewFileName()
  getFileExtension()
  getMediumSizePreviewFileName()
  getOriginalSizeFileName()
  getNormalizedDescription()
  isImage()
  isSound()
  isVideo()
  isZip()
  getResourceLink()
  getLink()
  getPreviewLink()
  getMediumPreviewLink()


Classe: GalleryResource  - X-Ref

\ingroup Gallery

Encapsulates a resource from our database.

Each GalleryResource object can belong to only one GalleryAlbum object, and therefore every object
has a reference to its album.

This class also provides methods for getting the correct metadata reader, for checking the type of the
resource, for getting access to the thumbnail of the object, etc.
GalleryResource( $ownerId, $albumId, $description, $flags, $resourceType,$filePath, $fileName, $metadata, $date, $thumbnailFormat, $properties = Array()   X-Ref
Constructor.

param: ownerId Id of the user to whom this resource belongs
param: albumId The id of the GalleryAlbum object to which this resource belongs
param: description Description of this file
param: flags As of pLog 1.0, there is only one flag available: GALLERY_RESOURCE_PREVIEW_AVAILABLE.
param: resourceType The type of the resource. One of the following constants:
param: filePath path in disk to the real file. Not used.
param: fileName name of the file, which is not exactly the same name that the file has in disk, since the
param: metadata An array, as generated by the getID3 class.
param: date A SQL date
param: thumbnailFormat The format of the thumbnail
param: id Optinally, the id. When creating new resources, the GalleryResources::addResource() method will

getId()   X-Ref

return: the identifier of the resource, or -1 if none has been set yet.

getOwnerId()   X-Ref

return: the identifier of the owner of this resource

getBlogInfo()   X-Ref

return: the bloginfo of the owner of this resource

getAlbumId()   X-Ref

return: returns the identifier of the GalleryAlbum object to which this resource belongs

getDate()   X-Ref

return: Returns a 14-digit SQL date

getTimestamp()   X-Ref

return: Returns a Timestamp object

getMetadata()   X-Ref

return: returns the "raw" metadata information, as generated by the getID3 class. It is

setMetadata( $metadata )   X-Ref
Set the resource metadata to the given array

param: metadata
return: Nothing

getFlags()   X-Ref

return: the flags of the resource object

getFilePath()   X-Ref

return: The path of the file in disk

getFileName()   X-Ref

return: the name of the file in disk

getEncodedFileName()   X-Ref

return: the encoded name of the file in disk

getDescription()   X-Ref

return: the description of the resource

getMimeType()   X-Ref
returns the mime type of the resource

return: a valid mime type

getThumbnailMimeType()   X-Ref
returns the mime type of the thumbnails

return: a valid mime type

getResourceType()   X-Ref
Pas de description

setAlbumId( $albumId )   X-Ref
Sets the album id. You should normally not need to use this method

param: albumId The id of the album

setAlbum( $album )   X-Ref
Sets the GalleryAlbum object to which this file belongs


getAlbum()   X-Ref

return: The GalleryAlbum object to which this resource belongs

setDescription( $description )   X-Ref
Sets the descriptoion of the object

param: description the new description

getThumbnailFormat()   X-Ref

return: returns the format of the thumbnail that was generated for this file, if any. Of

setThumbnailFormat( $format )   X-Ref
Sets the thumbnail format

return: nothing

getFileSize()   X-Ref
returns the size of the resource file

return: the size of the file in bytes

setFileSize( $size )   X-Ref
Pas de description

getMetadataReader()   X-Ref
returns an object that will allow to access the metadata of this resource


hasPreview()   X-Ref
Returns true if this resource has a preview or false if not.

return: True if preview available or false otherwise.

getPreviewFileName()   X-Ref
returns the name of the file in disk where the preview is
stored

return: the path to the small preview file

getFileExtension( $toLower = false )   X-Ref
Returns the file extension

param: toLower Whether the extension should be returned in lower case, false by default
return: The file extension

getMediumSizePreviewFileName()   X-Ref
returns the full path to the file with the medium-sized preview

return: full path to the medium-sized preview

getOriginalSizeFileName()   X-Ref
returns the full path to the file with the original size

return: full path to the original size

getNormalizedDescription()   X-Ref
Pas de description

isImage()   X-Ref

return: true if the resource is an image

isSound()   X-Ref

return: true if the resource is a sound file

isVideo()   X-Ref

return: true if the resource file is a video

isZip()   X-Ref

return: true if the resource file is a ZIP file

getResourceLink()   X-Ref
returns the link to the resource page


getLink()   X-Ref
returns the download link for this resource


getPreviewLink()   X-Ref
returns the preview link (thumbnail) for this resource if it's an image, or an empty string otherwise


getMediumPreviewLink()   X-Ref
returns the medium preview link (thumbnail) for this resource if it's an image,
or an empty string otherwise




Généré le : Mon Nov 26 21:04:15 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics