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

Class: MediaObject

Source Location: /classes.php

Class MediaObject

Descendants
Child Class Description
AlbumBase Root class for images and albums
Image handles 'picture' images

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

Inherited From ThemeObject

ThemeObject::$comments
ThemeObject::$manage_rights
ThemeObject::$manage_some_rights
ThemeObject::$view_rights

Inherited From PersistentObject

PersistentObject::$exists
PersistentObject::$id
PersistentObject::$loaded
PersistentObject::$table
PersistentObject::$transient

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()
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::getData()
returns the database record of the object
PersistentObject::getID()
Returns the id
PersistentObject::instantiate()
Prime instantiator for Zenphoto objects
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.
PersistentObject::__toString()
"Magic" function to return a string identifying the object when it is treated as a string

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

[ Top ]
Methods
Constructor __construct  [line 748]

  MediaObject __construct( )

Class instantiator



Redefinition of:
ThemeObject::__construct()
Class instantiator

Redefined in descendants as:

[ Top ]
getDesc  [line 757]

  string getDesc( [ $locale = NULL]  )

Returns the description

Parameters:
   $locale: 


[ Top ]
getExpireDate  [line 862]

  string getExpireDate( )

Returns the expire date



[ Top ]
getPassword  [line 817]

  string getPassword( )

Returns the password



[ Top ]
getPasswordHint  [line 839]

  string getPasswordHint( [ $locale = NULL]  )

Returns the password hint

Parameters:
   $locale: 


[ Top ]
getPublishDate  [line 891]

  string getPublishDate( )

Returns the publish date



[ Top ]
getSortOrder  [line 781]

  string getSortOrder( )

Returns the sort order



[ Top ]
getUser  [line 799]

  string getUser( )

Returns the guest user



[ Top ]
setDesc  [line 771]

  void setDesc( string $desc  )

Stores the description

Parameters:
string   $desc:  description text


[ Top ]
setExpireDate  [line 875]

  void setExpireDate( $ed  )

sets the expire date

Parameters:
   $ed: 


[ Top ]
setPassword  [line 830]

  void setPassword( string $pwd  )

Sets the encrypted password

Parameters:
string   $pwd:  the cleartext password


[ Top ]
setPasswordHint  [line 853]

  void setPasswordHint( string $hint  )

Sets the password hint

Parameters:
string   $hint:  the hint text


[ Top ]
setPublishDate  [line 904]

  void setPublishDate( $ed  )

sets the publish date

Parameters:
   $ed: 


[ Top ]
setSortOrder  [line 790]

  void setSortOrder( string $sortorder  )

Stores the sort order

Parameters:
string   $sortorder:  image sort order


[ Top ]
setUser  [line 808]

  void setUser( string $user  )

Sets the guest user

Parameters:
string   $user: 


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:20 +0200 by phpDocumentor 1.4.3