ZenpageCategory __construct(
$catlink, [
$create = NULL]
)
|
|
Parameters:
Redefinition of:
- ThemeObject::__construct()
- Class instantiator
void checkforGuest(
[$hint
&$hint = NULL], [$show
&$show = NULL]
)
|
|
Checks if user is allowed to access news category
Parameters:
|
$hint |
&$hint: |
|
|
$show |
&$show: |
|
int getArticle(
int
$index, [
$published = NULL], [
$sortorder = 'date'], [
$sortdirection = 'desc'], [
$sticky = true]
)
|
|
Returns an article from the album based on the index passed.
Parameters:
|
int |
$index: |
|
|
|
$published: |
|
|
|
$sortorder: |
|
|
|
$sortdirection: |
|
|
|
$sticky: |
|
array getArticles(
[int
$articles_per_page = 0], [string
$published = NULL], [boolean
$ignorepagination = false], [string
$sortorder = NULL], [string
$sortdirection = NULL], [bool
$sticky = NULL]
)
|
|
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:
|
int |
$articles_per_page: |
The number of articles to get |
|
string |
$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 |
|
boolean |
$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) |
|
string |
$sortorder: |
"date" (default), "title", "popular", "mostrated", "toprated", "random" This parameter is not used for date archives |
|
string |
$sortdirection: |
"asc" or "desc" for ascending or descending order This parameter is not used for date archives |
|
bool |
$sticky: |
set to true to place "sticky" articles at the front of the list. |
string getContent(
[
$locale = NULL]
)
|
|
Returns the content
Parameters:
string getDesc(
[
$locale = NULL]
)
|
|
Returns the description
Parameters:
string getExtraContent(
[
$locale = NULL]
)
|
|
Returns the extra content
Parameters:
int getIndex(
$sortorder,
$sortdirection,
$sticky
)
|
|
Get the index of this article
Parameters:
|
|
$sortorder: |
|
|
|
$sortdirection: |
|
|
|
$sticky: |
|
string getLink(
[string
$page = NULL]
)
|
|
Returns the full path to a news category
Parameters:
|
string |
$page: |
The category page number |
object getNextArticle(
[
$sortorder = 'date'], [
$sortdirection = 'desc'], [
$sticky = true]
)
|
|
Returns the next article.
Parameters:
|
|
$sortorder: |
|
|
|
$sortdirection: |
|
|
|
$sticky: |
|
array getParents(
[
&$parentid = ''], [bool
$initparents = true], int
$parentid
)
|
|
Gets the parent categories recursivly to the category whose parentid is passed or the current object
Parameters:
|
int |
$parentid: |
The parentid of the category to get the parents of |
|
bool |
$initparents: |
|
|
|
&$parentid: |
|
object getPrevArticle(
[
$sortorder = 'date'], [
$sortdirection = 'desc'], [
$sticky = true]
)
|
|
Return the previous article
Parameters:
|
|
$sortorder: |
|
|
|
$sortdirection: |
|
|
|
$sticky: |
|
array getSubCategories(
[bool
$visible = true], [string
$sorttype = NULL], [string
$sortdirection = NULL]
)
|
|
Gets the sub categories recursivly by titlelink
Parameters:
|
bool |
$visible: |
TRUE for published and unprotected |
|
string |
$sorttype: |
NULL for the standard order as sorted on the backend, "title", "date", "popular" |
|
string |
$sortdirection: |
"asc" or "desc" for ascending or descending order |
Checks if a category 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.
bool isSubNewsCategoryOf(
$catlink
)
|
|
Checks if the current news category is a sub category of $catlink
Parameters:
Deletes a category (and also if existing its subpages) from the database
Redefinition of:
- PersistentObject::remove()
- Deletes object from the database
Set the content datum
Parameters:
|
$c |
$c: |
full language string |
void setDesc(
string
$desc
)
|
|
Stores the description
Parameters:
|
string |
$desc: |
description text |
void setExtraContent(
$ec
)
|
|
sets the extra content
Parameters:
void setPassword(
string
$pwd
)
|
|
Sets the encrypted password
Parameters:
|
string |
$pwd: |
the cleartext password |
void setPasswordHint(
string
$hint
)
|
|
Sets the password hint
Parameters:
|
string |
$hint: |
the hint text |
void setSortDirection(
$value
)
|
|
Parameters:
void setSortOrder(
string
$sortorder
)
|
|
Stores the sort order
Parameters:
|
string |
$sortorder: |
image sort order |
void setSortSticky(
$value
)
|
|
Parameters:
void setSortType(
$value
)
|
|
Parameters:
void setUser(
string
$user
)
|
|
Sets the guest user
Parameters:
