Class ZenpageCategory

zenpage news category class

ThemeObject

ZenpageRoot

ZenpageCategory

Package: plugins\zenpage
Author: Malte Müller (acrylian)
Located at zp-extensions/zenpage/zenpage-class-category.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`	# `getContent( $locale = NULL )` Returns the content Returns the content Returns string
`public`	# `setContent( $c )` Set the content datum Parameters `$c` language string
`public string`	# `getExtraContent( $locale = NULL )` Returns the extra content Returns the extra content Returns string
`public`	# `setExtraContent( $ec )` sets the extra content sets the extra content
`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`	# `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`	# `getSubCategories( boolean $visible = true, string $sorttype = NULL, string $sortdirection = NULL )` 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` "asc" or "desc" for ascending or descending order Returns array
`public boolean`	# `isSubNewsCategoryOf( $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
`public array`	# `getParents( integer & $parentid = '', boolean $initparents = true )` Gets the parent categories recursivly to the category whose parentid is passed or the current object Gets the parent categories recursivly to the category whose parentid is passed or the current object Parameters `$parentid` The parentid of the category to get the parents of `$initparents` Returns array
`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`	# `isMyItem( bit $action )` Checks basic access rights of an object Checks basic access rights of an object Parameters `$action` what the caller wants to do 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 )` 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. 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
`public type`	# `getCategoryLink( )` Deprecated Returns type

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

Properties summary
`public`	`$manage_rights`	# `MANAGE_ALL_NEWS_RIGHTS`
`public`	`$manage_some_rights`	# `ZENPAGE_NEWS_RIGHTS`
`public`	`$view_rights`	# `ALL_NEWS_RIGHTS`
`protected string`	`$sortorder`	# `'date'`
`protected boolean`	`$sortdirection`	# `true`
`protected boolean`	`$sortSticky`	# `true`

Properties inherited from ThemeObject
`$comments`

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

Packages

Classes

Functions

Class ZenpageCategory

Overrides

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Deprecated

Returns