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

Class: ThemeObject

Source Location: /classes.php

Class ThemeObject

Class Overview
Class Overview | Descendants | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

The basic ThemeObject class. Extends PersistentObject, is extended by various Theme related objects.

Provides some basic methods that all use.

Located in /classes.php [line 420] 

PersistentObject
   |
   --ThemeObject

Properties

Methods
[ Top ]
Descendants
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
MediaObject Root class for images and albums
ZenpageRoot Base class from which all Zenpage classes derive

[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Descendants | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From PersistentObject

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

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 ]
Property Summary
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
mixed   $comments  
mixed   $manage_rights  
mixed   $manage_some_rights  
mixed   $view_rights  

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

[ Top ]
Properties
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
mixed   $comments = NULL [line 423]

[ Top ]
mixed   $manage_rights = ADMIN_RIGHTS [line 424]
Redefined in descendants as:

[ Top ]
mixed   $manage_some_rights = ADMIN_RIGHTS [line 425]
Redefined in descendants as:

[ Top ]
mixed   $view_rights = VIEW_ALL_RIGHTS [line 426]
Redefined in descendants as:

[ Top ]
Methods
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Constructor __construct  [line 431]

  ThemeObject __construct( )

Class instantiator


Redefined in descendants as:

[ Top ]
addComment  [line 675]

  object addComment( string $name, string $email, string $website, string $comment, string $code, string $code_ok, string $ip, bool $private, bool $anon, string $customdata  )

Adds comments to the album assumes data is coming straight from GET or POST

Returns a comment object

 Parameters:
string   $name:  Comment author name
string   $email:  Comment author email
string   $website:  Comment author website
string   $comment:  body of the comment
string   $code:  CAPTCHA code entered
string   $code_ok:  CAPTCHA hash expected
string   $ip:  the IP address of the comment poster
bool   $private:  set to true if the comment is for the admin only
bool   $anon:  set to true if the poster wishes to remain anonymous
string   $customdata: 


[ Top ]
checkAccess  [line 729]

  void checkAccess( [ &$hint = NULL], [ &$show = NULL], string $hint, string $show  )

Checks if viewing of object is allowed

Parameters:
string   $hint: 
string   $show: 
   &$hint: 
   &$show: 

Redefined in descendants as:

[ Top ]
checkForGuest  [line 719]

  void checkForGuest( [$hint &$hint = NULL], [$show &$show = NULL]  )

returns false (deny) if gallery is "private"

Parameters:
$hint   &$hint: 
$show   &$show: 


[ Top ]
countHit  [line 487]

  void countHit( )

counts visits to the object



[ Top ]
getCodeblock  [line 578]

  array getCodeblock( )

Returns the codeblocks as an serialized array



[ Top ]
getCommentCount  [line 685]

  int getCommentCount( )

Returns the count of comments in the album. Ignores comments in moderation



[ Top ]
getComments  [line 639]

  array getComments( [bool $moderated = false], [bool $private = false], [bool $desc = false]  )

Returns an array of comments for this album

Parameters:
bool   $moderated:  if false, ignores comments marked for moderation
bool   $private:  if false ignores private comments
bool   $desc:  set to true for descending order


[ Top ]
getCommentsAllowed  [line 618]

  bool getCommentsAllowed( )

Retuns true if comments are allowed



[ Top ]
getCustomData  [line 595]

  string getCustomData( [ $locale = NULL]  )

returns the custom data field

Parameters:
   $locale: 


[ Top ]
getDateTime  [line 553]

  int getDateTime( )

Returns the unformatted date



[ Top ]
getHitcounter  [line 480]

  int getHitcounter( )

Returns the hitcount



[ Top ]
getParentID  [line 463]

  string getParentID( )

Returns the partent id


Redefined in descendants as:

[ Top ]
getShow  [line 497]

  bool getShow( )

Returns true published



[ Top ]
getTags  [line 520]

  string getTags( )

Returns the tag data



[ Top ]
getTitle  [line 440]

  string getTitle( [ $locale = NULL]  )

Returns the title

Parameters:
   $locale: 


[ Top ]
hasTag  [line 543]

  bool hasTag( string $checktag  )

Checks if an object has a tag assigned.

Parameters:
string   $checktag:  tag to check for


[ Top ]
isMyItem  [line 701]

  void isMyItem( bit $action  )

Checks basic access rights of an object

Parameters:
bit   $action:  what the caller wants to do

Redefined in descendants as:

[ Top ]
setCodeblock  [line 586]

  void setCodeblock( $cb  )

set the codeblocks as an serialized array

Parameters:
   $cb: 


[ Top ]
setCommentsAllowed  [line 627]

  void setCommentsAllowed( bool $commentson  )

Sets the comments allowed flag

Parameters:
bool   $commentson:  true if they are allowed


[ Top ]
setCustomData  [line 609]

  void setCustomData( string $val  )

Sets the custom data field

Parameters:
string   $val:  the value to be put in custom_data


[ Top ]
setDateTime  [line 562]

  void setDateTime( string $datetime  )

Stores the date

Parameters:
string   $datetime:  formatted date


[ Top ]
setParentID  [line 471]

  void setParentID( $v $v  )

Sets the ParentID field

Parameters:
$v   $v:  id of the parent


[ Top ]
setShow  [line 506]

  void setShow( bool $show  )

Stores the published value

Parameters:
bool   $show:  True if the album is published


[ Top ]
setTags  [line 529]

  void setTags( string $tags  )

Stores tag information

Parameters:
string   $tags:  the tag list


[ Top ]
setTitle  [line 454]

  void setTitle( string $title  )

Stores the title

Parameters:
string   $title:  the title


[ Top ]
classes
Packages:
core
admin
classes
functions
plugins

Files:
class-album.php
class-comment.php
class-feed.php
class-gallery.php
class-image.php
class-search.php
classes.php
lib-auth.php

media
class-video.php

Classes:
Album
AlbumBase
Comment
dynamicAlbum
favorites
feed
Gallery
Image
MediaObject
PersistentObject
SearchEngine
ThemeObject
Transientimage
Zenphoto_Administrator
Zenphoto_Authority
media
pseudoPlayer
Video
VideoObject_Options
Documentation generated on Sat, 07 Jun 2014 18:03:20 +0200 by phpDocumentor 1.4.3