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

Class: Video

Source Location: /zp-extensions/class-video.php

Class Video

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

Inherited From _Image

_Image::$album
_Image::$displayname
_Image::$exists
_Image::$filemtime
_Image::$filename
_Image::$index
_Image::$localpath
_Image::$manage_rights
_Image::$manage_some_rights
_Image::$objectsThumb
_Image::$sidecars
_Image::$sortorder
_Image::$view_rights
_Image::$webpath

Inherited From ThemeObject

ThemeObject::$commentcount
ThemeObject::$comments

Inherited From PersistentObject

PersistentObject::$cache_by
PersistentObject::$data
PersistentObject::$id
PersistentObject::$loaded
PersistentObject::$table
PersistentObject::$tempdata
PersistentObject::$transient
PersistentObject::$unique_set
PersistentObject::$updates
PersistentObject::$use_cache

Inherited From _Image

_Image::_Image()
Constructor for class-image
_Image::checkAccess()
returns true if user is allowed to see the image
_Image::checkforGuest()
Checks if guest is loggedin for the album
_Image::classSetup()
generic "image" class setup code Returns true if valid image.
_Image::copy()
Copies the image to a new album, along with all metadata.
_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::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::getCustomImage()
Get a custom sized version of this image based on the parameters.
_Image::getDefaultTitle()
_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::getImageFootprint()
Returns the disk size 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::getIPTCTag()
For internal use--fetches a single tag from IPTC data
_Image::getIPTCTagArray()
For internal use--fetches the IPTC array for a single tag.
_Image::getLocation()
Returns the location field of the image
_Image::getMetaData()
Returns an array of EXIF data
_Image::getNextImage()
Returns the next Image.
_Image::getOwner()
Owner functions
_Image::getPrevImage()
Return the previous Image
_Image::getSizedImage()
Returns a path to a sized version of the image
_Image::getState()
Returns the state field of the image
_Image::getThumb()
Get a default-sized thumbnail of this image.
_Image::getThumbCropping()
Returns an array of cropping parameters. Used as a "helper" function for various inherited getThumb() methods
_Image::getThumbImageFile()
Returns the image file name for the thumbnail image.
_Image::getWatermark()
Returns the custom watermark name
_Image::getWidth()
Returns the width of the image
_Image::getWMUse()
Returns the custom watermark usage
_Image::isMyItem()
_Image::isProtected()
returns true if there is any protection on the image
_Image::moveImage()
Moves an image to a new album and/or filename (rename).
_Image::remove()
Permanently delete this image (permanent: be careful!)
_Image::rename()
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::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::setLocation()
Stores the location field of the image
_Image::setOwner()
_Image::setState()
Stores the state field of the image
_Image::setWatermark()
Set custom watermark
_Image::setWMUse()
Sets the custom watermark usage
_Image::updateDimensions()
Update this object's values for width and height.
_Image::updateMetaData()
Parses Exif/IPTC data

Inherited From MediaObject

MediaObject::__construct()
Class instantiator
MediaObject::getDesc()
Returns the description
MediaObject::getExpireDate()
Returns the expire date
MediaObject::getPassword()
Returns the password
MediaObject::getPasswordHint()
Returns the password hint
MediaObject::getPublishDate()
Returns the publish date
MediaObject::getSortOrder()
Returns the sort order
MediaObject::getUser()
Returns the guest user
MediaObject::setDesc()
Stores the description
MediaObject::setExpireDate()
sets the expire date
MediaObject::setPassword()
Sets the encrypted password
MediaObject::setPasswordHint()
Sets the password hint
MediaObject::setPublishDate()
sets the publish date
MediaObject::setSortOrder()
Stores the sort order
MediaObject::setUser()
Sets the guest user

Inherited From ThemeObject

ThemeObject::__construct()
Class instantiator
ThemeObject::addComment()
Adds comments to the album assumes data is coming straight from GET or POST
ThemeObject::checkAccess()
Checks if viewing of object is allowed
ThemeObject::checkForGuest()
returns false (deny) if gallery is "private"
ThemeObject::countHit()
counts visits to the object
ThemeObject::getCodeblock()
Returns the codeblocks as an serialized array
ThemeObject::getCommentCount()
Returns the count of comments in the album. Ignores comments in moderation
ThemeObject::getComments()
Returns an array of comments for this album
ThemeObject::getCommentsAllowed()
Retuns true if comments are allowed
ThemeObject::getCustomData()
returns the custom data field
ThemeObject::getDateTime()
Returns the unformatted date
ThemeObject::getHitcounter()
Returns the hitcount
ThemeObject::getParentID()
Returns the partent id
ThemeObject::getShow()
Returns true published
ThemeObject::getTags()
Returns the tag data
ThemeObject::getTitle()
Returns the title
ThemeObject::hasTag()
Checks if an object has a tag assigned.
ThemeObject::isMyItem()
Checks basic access rights of an object
ThemeObject::setCodeblock()
set the codeblocks as an serialized array
ThemeObject::setCommentsAllowed()
Sets the comments allowed flag
ThemeObject::setCustomData()
Sets the custom data field
ThemeObject::setDateTime()
Stores the date
ThemeObject::setParentID()
Sets the ParentID field
ThemeObject::setShow()
Stores the published value
ThemeObject::setTags()
Stores tag information
ThemeObject::setTitle()
Stores the title

Inherited From PersistentObject

PersistentObject::PersistentObject()
Prime instantiator for Zenphoto objects
PersistentObject::copy()
Copy this record to another unique set. Checks if the record exists there first, if so returns false. If successful returns true. No changes are made to this object and no other objects are created, just the database entry.
PersistentObject::get()
Get the value of a variable. If $current is false, return the value as of the last save of this object.
PersistentObject::getID()
Returns the id
PersistentObject::move()
Change one or more values of the unique set assigned to this record.
PersistentObject::remove()
Deletes object from the database
PersistentObject::save()
Save the updates made to this object since the last update. Returns true if successful, false if not.
PersistentObject::set()
Set a variable in this object. Does not persist to the database until save() is called. So, IMPORTANT: Call save() after set() to persist.
PersistentObject::setDefaults()
Sets default values for new objects using the set() method.

[ Top ]
Method Summary
Image   __construct()   Constructor for class-video
string   getBody()   returns the content of the vido
string   getCustomImage()   Get a custom sized version of this image based on the parameters.
void   getSizedImage()   (non-PHPdoc)
string   getThumb()   Get a default-sized thumbnail of this image.
string   getThumbImageFile()   Returns the image file name for the thumbnail image.
void   updateDimensions()   Update this object's values for width and height.
void   updateMetaData()   Processes multi-media file metadata

[ Top ]
Methods
Constructor __construct  [line 70]

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

Constructor for class-video

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


Redefinition of:
MediaObject::__construct()
Class instantiator

[ Top ]
getBody  [line 287]

  string getBody( [$w $w = NULL], [$h $h = NULL]  )

returns the content of the vido

Parameters:
$w   $w: 
$h   $h: 


[ Top ]
getCustomImage  [line 227]

  string getCustomImage( int $size, int $width, int $height, int $cropw, int $croph, int $cropx, int $cropy, [bool $thumbStandin = false], [bool $effects = NULL], 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 to true to treat as thumbnail
bool   $effects:  ignored


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

[ Top ]
getSizedImage  [line 269]

  void getSizedImage( $size  )

(non-PHPdoc)

Parameters:
   $size: 

API Tags:
See:  zp-core/_Image::getSizedImage()


Redefinition of:
_Image::getSizedImage()
Returns a path to a sized version of the image

[ Top ]
getThumb  [line 186]

  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 ]
getThumbImageFile  [line 135]

  string getThumbImageFile( [string $path = NULL]  )

Returns the image file name for the thumbnail image.

Parameters:
string   $path:  override path


Redefinition of:
_Image::getThumbImageFile()
Returns the image file name for the thumbnail image.

[ Top ]
updateDimensions  [line 103]

  void updateDimensions( )

Update this object's values for width and height.



Redefinition of:
_Image::updateDimensions()
Update this object's values for width and height.

[ Top ]
updateMetaData  [line 346]

  void updateMetaData( )

Processes multi-media file metadata

(non-PHPdoc)


API Tags:
See:  zp-core/_Image::updateMetaData()


Redefinition of:
_Image::updateMetaData()
Parses Exif/IPTC data

[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:06:54 +0100 by phpDocumentor 1.4.3