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: |
|
array getArticles(
[int
$articles_per_page = ''], [string
$published = NULL], [boolean
$ignorepagination = false], [string
$sortorder = "date"], [string
$sortdirection = "desc"], [bool
$sticky = true]
)
|
|
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" for sorting by date (default) "title" for sorting by title This parameter is not used for date archives |
|
string |
$sortdirection: |
"desc" (default) for descending sort order "asc" for ascending sort 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 getCategoryLink(
string
$catlink
)
|
|
Returns the full path to a news category
Parameters:
|
string |
$catlink: |
The category link of a category |
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: |
|
array getSubCategories(
)
|
|
Gets the sub categories recursivly by titlelink
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
void setDesc(
string
$desc
)
|
|
Stores the description
Parameters:
|
string |
$desc: |
description text |
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 setSortOrder(
string
$sortorder
)
|
|
Stores the sort order
Parameters:
|
string |
$sortorder: |
image sort order |
void setUser(
string
$user
)
|
|
Sets the guest user
Parameters:
Twitter
Youtube