[ 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 ZenpageRoot

ZenpageRoot::$sortdirection
ZenpageRoot::$sortorder
ZenpageRoot::$sortSticky

Inherited From ThemeObject

ThemeObject::$comments

Inherited From PersistentObject

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

Inherited From ZenpageItems

ZenpageItems::__construct()
Class instantiator
ZenpageItems::getAuthor()
Returns the author
ZenpageItems::getContent()
Returns the content
ZenpageItems::getExpireDate()
Returns the expire date
ZenpageItems::getExtraContent()
Returns the extra content
ZenpageItems::getLastchange()
Returns the last change date
ZenpageItems::getLastchangeAuthor()
Returns the last change author
ZenpageItems::getLocked()
Returns the locked status , "1" if locked (only used on the admin)
ZenpageItems::setAuthor()
sets the author attribute
ZenpageItems::setContent()
Set the content datum
ZenpageItems::setExpireDate()
sets the expire date
ZenpageItems::setExtraContent()
sets the extra content
ZenpageItems::setLastchange()
sets the last change date
ZenpageItems::setLastchangeAuthor()
stores the last change author
ZenpageItems::setLocked()
sets the locked status , "1" if locked (only used on the admin)

Inherited From ZenpageRoot

ZenpageRoot::getPermalink()
Returns the perma link status (only used on admin)
ZenpageRoot::getTitlelink()
Returns the titlelink
ZenpageRoot::setPermalink()
ZenpageRoot::setTitlelink()
sets the title link

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 ]
Property Summary
mixed   $manage_rights  
mixed   $manage_some_rights  
mixed   $view_rights  

[ Top ]
Method Summary
ZenpagePage   __construct()  
void   checkforGuest()   Checks if user is allowed to access the page
void   copy()   duplicates an article
string   getLink()   Returns full path to a specific page
string   getPageLink()   Returns full path to a specific page
array   getPages()   Gets the sub pages of a page
array   getParents()   Gets the parent pages recursivly to the page whose parentid is passed or the current object
string   getPassword()   Returns the password
string   getPasswordHint()   Returns the password hint
string   getSortOrder()   Returns the sort order
array   getSubPages()   Gets the sub pages recursivly by titlelink
string   getUser()   Returns the guest user
void   isMyItem()   Checks if user is author of page
bool   isProtected()   Checks if a page is protected and returns TRUE or FALSE NOTE: This function does only check if a password is set not if it has been entered! Use $this->checkforGuest() for that.
void   remove()   Deletes a page (and also if existing its subpages) from the database
void   setPassword()   Sets the encrypted password
void   setPasswordHint()   Sets the password hint
void   setSortOrder()   Stores the sort order
void   setUser()   Sets the guest user

[ Top ]
Properties
mixed   $manage_rights = MANAGE_ALL_PAGES_RIGHTS [line 12]

Redefinition of:
ThemeObject::$manage_rights

[ Top ]
mixed   $manage_some_rights = ZENPAGE_PAGES_RIGHTS [line 13]

Redefinition of:
ThemeObject::$manage_some_rights

[ Top ]
mixed   $view_rights = ALL_PAGES_RIGHTS [line 14]

Redefinition of:
ThemeObject::$view_rights

[ Top ]
Methods
Constructor __construct  [line 16]

  ZenpagePage __construct( $titlelink, [ $allowCreate = NULL]  )

Parameters:
   $titlelink: 
   $allowCreate: 


Redefinition of:
ZenpageItems::__construct()
Class instantiator

[ Top ]
checkforGuest  [line 223]

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

Checks if user is allowed to access the page

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


[ Top ]
copy  [line 109]

  void copy( string $newtitle  )

duplicates an article

Parameters:
string   $newtitle:  the title for the new article


Redefinition of:
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.

[ Top ]
getLink  [line 299]

  string getLink( )

Returns full path to a specific page



[ Top ]
getPageLink  [line 309]

  string getPageLink( )

Returns full path to a specific page


API Tags:
Deprecated:  since version 1.4.6


[ Top ]
getPages  [line 195]

  array getPages( [bool $published = NULL], [bool $toplevel = false], [int $number = NULL], [string $sorttype = NULL], [string $sortdirection = NULL]  )

Gets the sub pages of a page

Parameters:
bool   $published:  TRUE for published or FALSE for all pages including un-published
bool   $toplevel:  ignored, left for parameter compatibility
int   $number:  number of pages to get (NULL by default for all)
string   $sorttype:  NULL for the standard order as sorted on the backend, "title", "date", "popular", "mostrated", "toprated", "random"
string   $sortdirection:  false for ascending, true for descending


[ Top ]
getParents  [line 162]

  array getParents( [ &$parentid = ''], [bool $initparents = true], int $parentid  )

Gets the parent pages recursivly to the page whose parentid is passed or the current object

Parameters:
int   $parentid:  The parentid of the page to get the parents of
bool   $initparents: 
   &$parentid: 


[ Top ]
getPassword  [line 65]

  string getPassword( )

Returns the password



[ Top ]
getPasswordHint  [line 87]

  string getPasswordHint( [ $locale = NULL]  )

Returns the password hint

Parameters:
   $locale: 


[ Top ]
getSortOrder  [line 29]

  string getSortOrder( )

Returns the sort order



[ Top ]
getSubPages  [line 213]

  array getSubPages( )

Gets the sub pages recursivly by titlelink


API Tags:
Deprecated:  


[ Top ]
getUser  [line 47]

  string getUser( )

Returns the guest user



[ Top ]
isMyItem  [line 272]

  void isMyItem( bit $action  )

Checks if user is author of page

Parameters:
bit   $action: 

what the caller wants to do

returns true of access is allowed



Redefinition of:
ThemeObject::isMyItem()
Checks basic access rights of an object

[ Top ]
isProtected  [line 262]

  bool isProtected( )

Checks if a page is protected and returns TRUE or FALSE NOTE: This function does only check if a password is set not if it has been entered! Use $this->checkforGuest() for that.



[ Top ]
remove  [line 133]

  void remove( )

Deletes a page (and also if existing its subpages) from the database



Redefinition of:
PersistentObject::remove()
Deletes object from the database

[ Top ]
setPassword  [line 78]

  void setPassword( string $pwd  )

Sets the encrypted password

Parameters:
string   $pwd:  the cleartext password


[ Top ]
setPasswordHint  [line 101]

  void setPasswordHint( string $hint  )

Sets the password hint

Parameters:
string   $hint:  the hint text


[ Top ]
setSortOrder  [line 38]

  void setSortOrder( string $sortorder  )

Stores the sort order

Parameters:
string   $sortorder:  image sort order


[ Top ]
setUser  [line 56]

  void setUser( string $user  )

Sets the guest user

Parameters:
string   $user: 


[ Top ]

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