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

Class: ZenpagePage

Source Location: /zp-extensions/zenpage/zenpage-class-page.php

Class ZenpagePage

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

Inherited From PersistentObject

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

Inherited From PersistentObject

PersistentObject::PersistentObject()
PersistentObject::cache()
Caches the current set of objects defined by a variable key $cache_by.
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::load()
Load the data array from the database, using the unique id set to get the unique record.
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 ]
Property Summary
mixed   $commentcount  
mixed   $comments  

[ Top ]
Method Summary
ZenpagePage   ZenpagePage()  
object   addComment()   Adds a comment to the page assumes data is coming straight from GET or POST
string   getAuthor()   Returns the author of the page
array   getCodeblock()   Returns the codeblocks of the page as an serialized array
int   getCommentCount()   Returns the count of comments for the current page. Comments in moderation are not counted
array   getComments()   Returns an array of comments of the current page
bool   getCommentsAllowed()   Returns true of comments are allowed
string   getContent()   Returns the content of the page
string   getDateTime()   Returns the date of the page
string   getExpireDate()   Returns the expire date of the page
string   getExtraContent()   Returns the extra content of the page
string   getHitcounter()   Returns the hitcount of the page
string   getID()   Returns the id of the page
string   getLastchange()   Returns the last change date of the page
string   getLastchangeAuthor()   Returns the last change author of the page
string   getLocked()   Returns the locked status of the page (only used on admin)
string   getParentID()   Returns the partent id of the page
string   getPassword()   Returns the page password
string   getPasswordHint()   Returns the password hint for the page
string   getPermalink()   Returns the perma link status of the page (only used on admin)
string   getShow()   Returns the show status of the page, "1" if published
string   getSortOrder()   Returns the sort order of the page
string   getTags()   Returns the tag data of an album
string   getTitle()   Returns the title of the page
string   getTitlelink()   Returns the titlelink of the page
string   getUser()   Returns the page guest user
void   setPassword()   Sets the encrypted page password
void   setPasswordHint()   Sets the page password hint
void   setTags()   Stores tag information of an album
void   setUser()   Sets the album guest user

[ Top ]
Properties
mixed   $commentcount [line 13]

[ Top ]
mixed   $comments = NULL [line 12]

[ Top ]
Methods
Constructor ZenpagePage  [line 15]

  ZenpagePage ZenpagePage( $titlelink  )

Parameters:
   $titlelink: 


[ Top ]
addComment  [line 256]

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

Adds a comment to the page 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 md5 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


[ Top ]
getAuthor  [line 108]

  string getAuthor( )

Returns the author of the page



[ Top ]
getCodeblock  [line 99]

  array getCodeblock( )

Returns the codeblocks of the page as an serialized array



[ Top ]
getCommentCount  [line 267]

  int getCommentCount( )

Returns the count of comments for the current page. Comments in moderation are not counted



[ Top ]
getComments  [line 220]

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

Returns an array of comments of the current page

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


[ Top ]
getCommentsAllowed  [line 210]

  bool getCommentsAllowed( )

Returns true of comments are allowed



[ Top ]
getContent  [line 54]

  string getContent( )

Returns the content of the page



[ Top ]
getDateTime  [line 117]

  string getDateTime( )

Returns the date of the page



[ Top ]
getExpireDate  [line 171]

  string getExpireDate( )

Returns the expire date of the page



[ Top ]
getExtraContent  [line 63]

  string getExtraContent( )

Returns the extra content of the page



[ Top ]
getHitcounter  [line 144]

  string getHitcounter( )

Returns the hitcount of the page



[ Top ]
getID  [line 27]

  string getID( )

Returns the id of the page



[ Top ]
getLastchange  [line 126]

  string getLastchange( )

Returns the last change date of the page



[ Top ]
getLastchangeAuthor  [line 135]

  string getLastchangeAuthor( )

Returns the last change author of the page



[ Top ]
getLocked  [line 153]

  string getLocked( )

Returns the locked status of the page (only used on admin)



[ Top ]
getParentID  [line 36]

  string getParentID( )

Returns the partent id of the page



[ Top ]
getPassword  [line 300]

  string getPassword( )

Returns the page password



[ Top ]
getPasswordHint  [line 321]

  string getPasswordHint( )

Returns the password hint for the page



[ Top ]
getPermalink  [line 162]

  string getPermalink( )

Returns the perma link status of the page (only used on admin)



[ Top ]
getShow  [line 81]

  string getShow( )

Returns the show status of the page, "1" if published



[ Top ]
getSortOrder  [line 72]

  string getSortOrder( )

Returns the sort order of the page



[ Top ]
getTags  [line 185]

  string getTags( )

Returns the tag data of an album



[ Top ]
getTitle  [line 45]

  string getTitle( )

Returns the title of the page



[ Top ]
getTitlelink  [line 90]

  string getTitlelink( )

Returns the titlelink of the page



[ Top ]
getUser  [line 286]

  string getUser( )

Returns the page guest user



[ Top ]
setPassword  [line 307]

  void setPassword( string $pwd  )

Sets the encrypted page password

Parameters:
string   $pwd:  the cleartext password


[ Top ]
setPasswordHint  [line 330]

  void setPasswordHint( string $hint  )

Sets the page password hint

Parameters:
string   $hint:  the hint text


[ Top ]
setTags  [line 194]

  void setTags( string $tags  )

Stores tag information of an album

Parameters:
string   $tags:  the tag list


[ Top ]
setUser  [line 293]

  void setUser( string $user  )

Sets the album guest user

Parameters:
string   $user: 


[ Top ]

Documentation generated on Mon, 09 Aug 2010 17:24:19 +0200 by phpDocumentor 1.4.1