Class ZenpageCategory

zenpage news category class

ThemeObject

ZenpageRoot

ZenpageCategory

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

Methods summary
`public`	# `__construct( $catlink, $create = NULL )` Class instantiator Class instantiator Overrides `ThemeObject::__construct()`
`public string`	# `getDesc( $locale = NULL )` Returns the description Returns the description Returns string
`public`	# `setDesc( string $desc )` Stores the description Stores the description Parameters `$desc` description text
`public string`	# `getSortOrder( )` Returns the sort order Returns the sort order Returns string
`public`	# `setDefaultSortorder( )` Sets a default sortorder for the category. Sets a default sortorder for the category. 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 the default sortorder if a category Gets the default sortorder if a category 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`	# `setSortOrder( string $sortorder )` Stores the sort order Stores the sort order Parameters `$sortorder` image sort order
`public`	# `getSortDirection( )`
`public`	# `setSortDirection( $value )`
`public`	# `getSortType( )`
`public`	# `setSortType( $value )`
`public`	# `getSortSticky( )`
`public`	# `setSortSticky( $value )`
`public`	# `getUser( )`
`public`	# `setUser( string $user )` Sets the guest user Sets the guest user Parameters `$user`
`public`	# `getPassword( )`
`public`	# `setPassword( string $pwd )` Sets the encrypted password Sets the encrypted password Parameters `$pwd` the cleartext password
`public`	# `getPasswordHint( )`
`public`	# `setPasswordHint( string $hint )` Sets the password hint Sets the password hint Parameters `$hint` the hint text
`public boolean`	# `remove( )` Deletes a category (and also if existing its subpages) from the database Deletes a category (and also if existing its subpages) from the database Returns boolean Overrides `PersistentObject::remove()`
`public array`	# `getCategories( boolean $visible = true, string $sorttype = NULL, boolean $sortdirection = NULL, boolean $directchilds = true )` Gets the sub categories recursivly by titlelink Gets the sub categories recursivly by titlelink Parameters `$visible` TRUE for published and unprotected `$sorttype` NULL for the standard order as sorted on the backend, "title", "date", "popular" `$sortdirection` True for descending (default), false for ascending direction `$directchilds` Default true to get only the direct sub level pages, set to false to get all levels Returns array Since ZenphotoCMS 1.5.8 - deprecates getSubCategories()
`public`	# `getSubCategories( $visible = true, $sorttype = NULL, $sortdirection = NULL, $directchilds = false )` Deprecated ZenphotoCMS 2.0 - Use getCategories() instead See `ZenpageCategory::getCategories()`
`public boolean`	# `isSubCategoryOf( $catlink )` Checks if the current news category is a sub category of $catlink Checks if the current news category is a sub category of $catlink Returns boolean Since ZenphotoCMS 1.5.8 - deprecates isSubNewsCategoryOf()
`public`	# `isSubNewsCategoryOf( $catlink )` Deprecated ZenphotoCMS 2.0 - Use getCategories() instead See `ZenpageCategory::isSubCategoryOf()`
`public obj\|null`	# `getParent( )` Gets the parent category object based on the parentid set Gets the parent category object based on the parentid set Returns obj\|null Since Zenphoto 1.5.5
`public array\|null`	# `getParents( )` Gets the parent categories' titlelinks recursivly to the category Gets the parent categories' titlelinks recursivly to the category Returns array\|null
`public`	# `checkforGuest( & $hint = NULL, & $show = NULL )` Checks if user is allowed to access news category Checks if user is allowed to access news category Parameters `$hint` `$show`
`public boolean`	# `isProtected( )` Checks if a category is protected and returns TRUE or FALSE Checks if a category is protected and returns TRUE or FALSE Returns boolean
`public boolean`	# `isPublic( )` Returns true if this category is published and also all of its parents. Returns true if this category is published and also all of its parents. Returns boolean Since Zenphoto 1.5.5
`public`	# `isMyItem( bit $action )` Checks if user is news author Checks if user is news author Parameters `$action` what the caller wants to do returns true of access is allowed Overrides `ThemeObject::isMyItem()`
`public array`	# `getArticles( integer $articles_per_page = 0, string $published = NULL, boolean $ignorepagination = false, string $sortorder = NULL, string $sortdirection = NULL, boolean $sticky = NULL, string $author = null )` Gets news articles titlelinks this category is attached to Gets news articles titlelinks this category is attached to NOTE: Since this function only returns titlelinks for use with the object model it does not exclude articles that are password protected via a category Parameters `$articles_per_page` The number of articles to get `$published` "published" for published articles, "published-unpublished" for published articles only from an unpublished category, "unpublished" for unpublished articles, "sticky" for sticky articles (published or not!) for Admin page use only, "all" for all articles `$ignorepagination` Since also used for the news loop this function automatically paginates the results if the "page" GET variable is set. To avoid this behaviour if using it directly to get articles set this TRUE (default FALSE) `$sortorder` "date" (default), "title", "popular", "mostrated", "toprated", "random" This parameter is not used for date archives `$sortdirection` "asc" or "desc" for ascending or descending order This parameter is not used for date archives `$sticky` set to true to place "sticky" articles at the front of the list. `$author` Optional author name to get the article of Returns array
`public integer`	# `getArticle( integer $index, $published = NULL, $sortorder = 'date', $sortdirection = 'desc', $sticky = true )` Returns an article from the album based on the index passed. Returns an article from the album based on the index passed. Parameters `$index` `$published` `$sortorder` `$sortdirection` `$sticky` Returns integer
`public integer`	# `getIndex( $sortorder, $sortdirection, $sticky )` Get the index of this article Get the index of this article Returns integer
`public object`	# `getPrevArticle( $sortorder = 'date', $sortdirection = 'desc', $sticky = true )` Return the previous article Return the previous article Returns object
`public object`	# `getNextArticle( $sortorder = 'date', $sortdirection = 'desc', $sticky = true )` Returns the next article. Returns the next article. Returns object
`public string`	# `getLink( string $page = NULL )` Returns the full path to a news category Returns the full path to a news category Parameters `$page` The category page number Returns string

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(), copy(), get(), getData(), getID(), getLastChange(), getLastChangeUser(), instantiate(), move(), save(), set(), setDefaults(), setLastChange(), setLastchangeUser()`

Properties summary
`public`	`$manage_rights`	# `MANAGE_ALL_NEWS_RIGHTS`
`public`	`$manage_some_rights`	# `ZENPAGE_NEWS_RIGHTS`
`public`	`$view_rights`	# `ALL_NEWS_RIGHTS`
`public`	`$parent`	# `null`
`public`	`$parents`	# `null`
`protected string`	`$sorttype`	# `'date'`
`protected boolean`	`$sortdirection`	# `true`
`protected boolean`	`$sortSticky`	# `true`
`protected`	`$is_public`	# `null`

Properties inherited from ThemeObject
`$comments`

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

Classes

Interfaces

Exceptions

Functions

Class ZenpageCategory

Overrides

Returns

Parameters

Returns

Since

Returns

Since

Parameters

Parameters

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Since

Deprecated

See

Returns

Since

Deprecated

See

Returns

Since

Returns

Parameters

Returns

Returns

Since

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns