[ class tree: classes ] [ index: classes ] [ all elements ]

Class: Video

Source Location: /class-video.php

Class Video

Class Overview

Video Class

Located in /class-video.php [line 10]

PersistentObject
   |
   --Image
      |
      --Video

Methods

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

Inherited From Image

Image::$album
Image::$commentcount
Image::$comments
Image::$displayname
Image::$exists
Image::$filemtime
Image::$filename
Image::$index
Image::$localpath
Image::$objectsThumb
Image::$sortorder
Image::$webpath

Inherited From Image

Image::Image()
Constructor for class-image
Image::addComment()
Adds a comment to the image assumes data is coming straight from GET or POST
Image::classSetup()
Image::copyImage()
Copies the image to a new album, along with all metadata.
Image::deleteImage()
Permanently delete this image (permanent: be careful!)
Image::fileChanged()
Returns true if the file has changed since last time we looked
Image::getAlbum()
Returns the album that holds this image
Image::getAlbumName()
Retuns the folder name of the album that holds this image
Image::getCity()
Returns the city field of the image
Image::getCommentCount()
Returns the count of comments for the image. Comments in moderation are not counted
Image::getComments()
Returns an array of comments
Image::getCommentsAllowed()
Retuns true if comments are allowed on the image
Image::getCopyright()
Returns the copyright field of the image
Image::getCountry()
Returns the country field of the image
Image::getCredit()
Returns the credit field of the image
Image::getCustomData()
returns the custom data field
Image::getCustomImage()
Get a custom sized version of this image based on the parameters.
Image::getDateTime()
Returns the unformatted date of the image
Image::getDefaultTitle()
Image::getDesc()
Returns the description of the image
Image::getExifData()
Returns an array of EXIF data
Image::getFileName()
Returns the image filename
Image::getFullImage()
Returns a path to the original image in the original folder.
Image::getHeight()
Returns the height of the image
Image::getImageLink()
Returns an image page link for the image
Image::getIndex()
Get the index of this image in the album, taking sorting into account.
Image::getLocation()
Returns the location field of the image
Image::getNextImage()
Returns the next Image.
Image::getPrevImage()
Return the previous Image
Image::getShow()
Returns true if the image is set visible
Image::getSizedImage()
Returns a path to a sized version of the image
Image::getSortOrder()
Returns the sort order value of the image
Image::getState()
Returns the state field of the image
Image::getTags()
Returns the tags of the image
Image::getThumb()
Get a default-sized thumbnail of this image.
Image::getTitle()
Returns the title of this image
Image::getWidth()
Returns the width of the image
Image::moveImage()
Moves an image to a new album and/or filename (rename).
Image::renameImage()
Renames an image to a new filename, keeping it in the same album. Convenience for moveImage($image->album, $newfilename).
Image::setCity()
Stores the city field of the image
Image::setCommentsAllowed()
Sets the comments allowed flag on the image
Image::setCopyright()
Stores the text for the copyright field of the image
Image::setCountry()
Stores the country field of the image
Image::setCredit()
Stores the credit field of the image
Image::setCustomData()
Sets the custom data field
Image::setDateTime()
Stores the date of the image
Image::setDesc()
Stores the description of the image
Image::setLocation()
Stores the location field of the image
Image::setShow()
Sets the visibility of the image
Image::setSortOrder()
Sets the sort order value of the image
Image::setState()
Stores the state field of the image
Image::setTags()
Sets the tags of the image
Image::setTitle()
Stores the title of this image
Image::updateDimensions()
Update this object's values for width and height. Uses lazy evaluation.

[ Top ]
Method Summary
Image   Video()   Constructor for class-image
string   getCustomImage()   Get a custom sized version of this image based on the parameters.
string   getThumb()   Get a default-sized thumbnail of this image.
void   updateDimensions()   Update this object's values for width and height. Uses lazy evaluation.

[ Top ]
Methods
Constructor Video  [line 19]

  Image Video( object &$album, sting $filename  )

Constructor for class-image

Parameters:
object   &$album:  the owning album
sting   $filename:  the filename of the image


[ Top ]
getCustomImage  [line 113]

  string getCustomImage( int $size, int $width, int $height, int $cropw, int $croph, int $cropx, int $cropy, [bool $thumbStandin = false], string $alt, string $class, string $id  )

Get a custom sized version of this image based on the parameters.

Parameters:
string   $alt:  Alt text for the url
int   $size:  size
int   $width:  width
int   $height:  height
int   $cropw:  crop width
int   $croph:  crop height
int   $cropx:  crop x axis
int   $cropy:  crop y axis
string   $class:  Optional style class
string   $id:  Optional style id
bool   $thumbStandin:  set true to inhibit watermarking


Redefinition of:
Image::getCustomImage()
Get a custom sized version of this image based on the parameters.

[ Top ]
getThumb  [line 75]

  string getThumb( [ $type = 'image']  )

Get a default-sized thumbnail of this image.

Parameters:
   $type: 


Redefinition of:
Image::getThumb()
Get a default-sized thumbnail of this image.

[ Top ]
updateDimensions  [line 59]

  void updateDimensions( )

Update this object's values for width and height. Uses lazy evaluation.



Redefinition of:
Image::updateDimensions()
Update this object's values for width and height. Uses lazy evaluation.

[ Top ]

Documentation generated on Tue, 02 Dec 2008 21:23:45 +0100 by phpDocumentor 1.4.1