Class ZenpagePage

zenpage page class

PersistentObject

ThemeObject

ZenpageRoot

ZenpageItems

ZenpagePage

Package: plugins\zenpage
Author: Malte Müller (acrylian)
Located at zp-extensions/zenpage/class-zenpagepage.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`	# `setDefaultSortorder( )` Sets a default sortorder for a page. Sets a default sortorder for a page. Use this before save() a) If you created an new item after you set a parentid and no new specific sortorder b) You updated the parentid without setting specific new sortorder The sortorder takes care of existing categories on the level and adds the item after existing ones. Since ZenphotoCMS 1.5.8
`public string`	# `getDefaultSortorder( )` Gets a default sortorder for a page. Gets a default sortorder for a page. Use this before save() a) If you created an new item after you set a parentid and no new specific sortorder b) You updated the parentid without setting specific new sortorder The sortorder takes care of existing categories on the level and adds the item after existing ones. Returns string Since ZenphotoCMS 1.5.8
`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 obj\|null`	# `getParent( )` Gets the parent page object based on the parentid set Gets the parent page object based on the parentid set Returns obj\|null Since Zenphoto 1.5.5
`public array`	# `getParents( )` Gets the parent pages' titlelinks recursivly to the page Gets the parent pages' titlelinks recursivly to the page Returns array
`public array`	# `getPages( boolean $published = NULL, boolean $directchilds = true, integer $number = NULL, string $sorttype = NULL, string $sortdirection = NULL, string $author = 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 `$directchilds` Default true to get only the direct sub level pages, set to false to get all levels `$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 `$author` Optional author name to get the pages of 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 boolean`	# `isPublic( )` Returns true if this page is published and also all of its parents. Returns true if this page is published and also all of its parents. Returns boolean Since Zenphoto 1.5.5
`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

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

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

Methods inherited from ThemeObject
addComment(), checkAccess(), checkForGuest(), checkPublishDates(), checkScheduledPublishing(), countHit(), getCodeblock(), getCommentCount(), getComments(), getCommentsAllowed(), getCustomData(), getDateTime(), getHitcounter(), getParentID(), getShow(), getTags(), getTitle(), hasExpiration(), hasExpireDate(), hasExpired(), hasFutureDate(), hasInactiveExpiration(), hasInactivePublishSchedule(), hasPublishSchedule(), hasTag(), isPublished(), setCodeblock(), setCommentsAllowed(), setCustomData(), setDateTime(), setParentID(), setPublished(), setShow(), setTags(), setTitle()

Methods inherited from PersistentObject
`__toString(), checkChanges(), clearCache(), get(), getData(), getID(), getLastChange(), getLastChangeUser(), instantiate(), move(), save(), set(), setDefaults(), setLastChange(), setLastchangeUser()`

Properties summary
`public`	`$manage_rights`	# `MANAGE_ALL_PAGES_RIGHTS`
`public`	`$manage_some_rights`	# `ZENPAGE_PAGES_RIGHTS`
`public`	`$view_rights`	# `ALL_PAGES_RIGHTS`
`public`	`$parent`	# `null`
`public`	`$parents`	# `null`
`protected`	`$is_public`	# `null`

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

Properties inherited from ThemeObject
`$comments`

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

Classes

Interfaces

Exceptions

Functions

Class ZenpagePage

Overrides

Returns

Parameters

Since

Returns

Since

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Overrides

Returns

Overrides

Returns

Since

Returns

Parameters

Returns

Parameters

Returns

Returns

Since

Parameters

Overrides

Returns