Class ZenpagePage

zenpage page class

PersistentObject

Extended by

ThemeObject

Extended by

ZenpageRoot

Extended by

ZenpageItems

Extended by

ZenpagePage

Package: plugins\zenpage
Author: Malte Müller (acrylian)
Located at zp-extensions/zenpage/zenpage-class-page.php

Methods summary
`public`	# `__construct( $titlelink, $allowCreate = NULL )` Class instantiator Class instantiator Overrides `ZenpageItems::__construct()`
`public string`	# `getSortOrder( )` Returns the sort order Returns the sort order Returns string
`public`	# `setSortOrder( string $sortorder )` Stores the sort order Stores the sort order Parameters `$sortorder` image sort order
`public string`	# `getUser( )` Returns the guest user Returns the guest user Returns string
`public`	# `setUser( string $user )` Sets the guest user Sets the guest user Parameters `$user`
`public string`	# `getPassword( )` Returns the password Returns the password Returns string
`public`	# `setPassword( string $pwd )` Sets the encrypted password Sets the encrypted password Parameters `$pwd` the cleartext password
`public string`	# `getPasswordHint( $locale = NULL )` Returns the password hint Returns the password hint Returns string
`public`	# `setPasswordHint( string $hint )` Sets the password hint Sets the password hint Parameters `$hint` the hint text
`public`	# `copy( string $newtitle )` duplicates an article duplicates an article Parameters `$newtitle` the title for the new article Overrides `PersistentObject::copy()`
`public boolean`	# `remove( )` Deletes a page (and also if existing its subpages) from the database Deletes a page (and also if existing its subpages) from the database Returns boolean Overrides `PersistentObject::remove()`
`public array`	# `getParents( integer & $parentid = '', boolean $initparents = true )` Gets the parent pages recursivly to the page whose parentid is passed or the current object Gets the parent pages recursivly to the page whose parentid is passed or the current object Parameters `$parentid` The parentid of the page to get the parents of `$initparents` Returns array
`public array`	# `getPages( boolean $published = NULL, boolean $toplevel = false, integer $number = NULL, string $sorttype = NULL, string $sortdirection = NULL )` Gets the sub pages of a page Gets the sub pages of a page Parameters `$published` TRUE for published or FALSE for all pages including un-published `$toplevel` ignored, left for parameter compatibility `$number` number of pages to get (NULL by default for all) `$sorttype` NULL for the standard order as sorted on the backend, "title", "date", "popular", "mostrated", "toprated", "random" `$sortdirection` false for ascending, true for descending Returns array
`public array`	# `getSubPages( )` Gets the sub pages recursivly by titlelink Gets the sub pages recursivly by titlelink Deprecated Returns array
`public`	# `checkforGuest( & $hint = NULL, & $show = NULL )` Checks if user is allowed to access the page Checks if user is allowed to access the page Parameters `$hint` `$show`
`public boolean`	# `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. 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. Returns boolean
`public`	# `isMyItem( bit $action )` Checks if user is author of page Checks if user is author of page Parameters `$action` what the caller wants to do returns true of access is allowed Overrides `ThemeObject::isMyItem()`
`public string`	# `getLink( )` Returns full path to a specific page Returns full path to a specific page Returns string
`public string`	# `getPageLink( )` Returns full path to a specific page Returns full path to a specific page Deprecated since version 1.4.6 Returns string

Methods inherited from ZenpageItems
`getAuthor(), getContent(), getExpireDate(), getExtraContent(), getLastchange(), getLastchangeAuthor(), getLocked(), setAuthor(), setContent(), setExpireDate(), setExtraContent(), setLastchange(), setLastchangeAuthor(), setLocked()`

Methods inherited from ZenpageRoot
`getPermalink(), getTitlelink(), setPermalink(), setTitlelink()`

Methods inherited from ThemeObject
`addComment(), checkAccess(), checkForGuest(), checkPublishDates(), countHit(), getCodeblock(), getCommentCount(), getComments(), getCommentsAllowed(), getCustomData(), getDateTime(), getHitcounter(), getParentID(), getShow(), getTags(), getTitle(), hasTag(), setCodeblock(), setCommentsAllowed(), setCustomData(), setDateTime(), setParentID(), setShow(), setTags(), setTitle()`

Methods inherited from PersistentObject
`__toString(), get(), getData(), getID(), instantiate(), move(), save(), set(), setDefaults()`

Properties summary
`public`	`$manage_rights`	# `MANAGE_ALL_PAGES_RIGHTS`
`public`	`$manage_some_rights`	# `ZENPAGE_PAGES_RIGHTS`
`public`	`$view_rights`	# `ALL_PAGES_RIGHTS`

Properties inherited from ZenpageRoot
`$sortSticky, $sortdirection, $sortorder`

Properties inherited from ThemeObject
`$comments`

Properties inherited from PersistentObject
`$exists, $id, $loaded, $table, $transient`