Class Zenpage

Zenpage root classes

Direct known subclasses

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

Methods summary
`public`	# `__construct( )` Class instantiator Class instantiator
`public static`	# `expiry( )`
`public type`	# `visibleCategory( type $cat )` Checks if a category itself is published. Checks if a category itself is published. Deprecated Zenphoto 2.0 Use the method isPublic() of the ZenpageCategory class instead. Parameters `$cat` Returns type
`public array`	# `getPages( boolean $published = NULL, boolean $toplevel = false, integer $number = NULL, string $sorttype = NULL, string $sortdirection = NULL, string $author = null, obj $pageobj = null )` Gets all pages or published ones. Gets all pages or published ones. NOTE: Since this function only returns titlelinks for use with the object model it does not exclude pages that are password protected Parameters `$published` TRUE for published or FALSE for all pages including un-published `$toplevel` TRUE for only the toplevel pages `$number` number of pages to get (NULL by default for all) `$sorttype` NULL for the standard order as sorted on the backend, "title", "date", "id", "popular", "mostrated", "toprated", "random" `$sortdirection` false for ascenting, true for descending `$author` Optional author name to get the pages of `$pageobj` Optional pageobj to get its subpages Returns array
`public array`	# `getNotViewablePages( )` Returns a list of Zenpage page IDs that the current viewer is not allowed to see Helper function to be used with getAllTagsUnique() and getAllTagsCount() Note if the Zenpage plugin is not enabled but items exists this returns no IDs so you need an extra check afterwards! Returns a list of Zenpage page IDs that the current viewer is not allowed to see Helper function to be used with getAllTagsUnique() and getAllTagsCount() Note if the Zenpage plugin is not enabled but items exists this returns no IDs so you need an extra check afterwards! Returns array
`public array`	# `getArticles( integer $articles_per_page = 0, string $published = NULL, boolean $ignorepagination = false, string $sortorder = NULL, boolean $sortdirection = NULL, boolean $sticky = NULL, obj $category = NULL, string $author = null )` Gets all news articles titlelink. Gets all news articles titlelink. 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 an published articles, "unpublished" for an unpublised articles, "published-unpublished" for published articles only from an unpublished category, "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", "id, "popular", "mostrated", "toprated", "random" This parameter is not used for date archives `$sortdirection` TRUE for descending, FALSE for ascending. Note: This parameter is not used for date archives `$sticky` set to true to place "sticky" articles at the front of the list. `$category` Optional category to get the article from `$author` Optional author name to get the articles of Returns array
`public array`	# `getNotViewableNews( )` Returns a list of Zenpage news article IDs that the current viewer is not allowed to see Helper function to be used with getAllTagsUnique() and getAllTagsCount() or db queries only Note if the Zenpage plugin is not enabled but items exists this returns no IDs so you need an extra check afterwards! Returns a list of Zenpage news article IDs that the current viewer is not allowed to see Helper function to be used with getAllTagsUnique() and getAllTagsCount() or db queries only Note if the Zenpage plugin is not enabled but items exists this returns no IDs so you need an extra check afterwards! Returns array
`public integer`	# `getArticle( integer $index, $published = NULL, $sortorder = NULL, $sortdirection = NULL, $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 static string`	# `getOffset( integer $articles_per_page, boolean $ignorepagination = false )` Gets the LIMIT and OFFSET for the query that gets the news articles Gets the LIMIT and OFFSET for the query that gets the news articles Parameters `$articles_per_page` The number of articles to get `$ignorepagination` If pagination should be ingored so always with the first is started (false is default) Returns string
`public`	# `getTotalArticles( )` Returns the articles count Returns the articles count
`public`	# `getTotalNewsPages( )` Gets the total news pages Gets the total news pages
`public array`	# `getAllArticleDates( boolean $yearsonly = false, string $order = 'desc' )` Retrieves a list of all unique years & months Retrieves a list of all unique years & months Parameters `$yearsonly` If set to true only the years' count is returned (Default false) `$order` 'desc' (default) or 'asc' for descending or ascending Returns array
`public array`	# `getCategory( integer $id )` Gets a category titlelink by id Gets a category titlelink by id Parameters `$id` id of the category Returns array
`public array`	# `getAllCategories( boolean $visible = true, string $sorttype = NULL, boolean $sortdirection = NULL, boolean $toplevel = false )` Gets all categories Gets all categories Parameters `$visible` TRUE for published and unprotected `$sorttype` NULL for the standard order as sorted on the backend, "title", "id", "popular", "random" `$sortdirection` TRUE for descending (default) or FALSE for ascending order `$toplevel` True for only toplevel categories Returns array
`public static array`	# `getAllAuthors( string $type = 'news' )` Gets all authors assigned to news articles or pages Gets all authors assigned to news articles or pages Parameters `$type` "news" or "pages" Returns array
`public string`	# `__toString( )` "Magic" function to return a string identifying the object when it is treated as a string Returns string
`public booliean`	# `getSortDirection( sting $what = 'news' )` Gets the internal default sortdirection Gets the internal default sortdirection Parameters `$what` "new", "pages", "categories" Returns booliean
`public`	# `setSortDirection( boolean $value, string $what = 'news' )` Sets the sortdirection Sets the sortdirection Parameters `$value` The true for decending false for ascending `$what` "new", "pages", "categories"
`public string`	# `getSortType( string $what = 'news' )` Gets the sorttype Gets the sorttype Parameters `$what` "new", "pages", "categories" Returns string
`public string`	# `setSortType( boolean $value, string $what = 'news' )` Sets the sortdtype Sets the sortdtype Parameters `$value` The field/sorttype to sort by `$what` "new", "pages", "categories" Returns string
`public`	# `getSortSticky( )`
`public`	# `setSortSticky( $value )`
`public string`	# `getItemDefaultSortorder( string $type = 'category' )` Gets the default sortorder for a Zenpage caategory or page that does not yet have one, e.g. because newly created The sortorder takae care of existing ones and add the item after existing items. Gets the default sortorder for a Zenpage caategory or page that does not yet have one, e.g. because newly created The sortorder takae care of existing ones and add the item after existing items. Parameters `$type` "category" or "page" Returns string Since ZenphotoCMS 1.5.8

Properties summary
`public`	`$categoryStructure`	# `null`
`protected string`	`$sorttype`	# `'date'`
`protected boolean`	`$sortdirection`	# `true`
`protected boolean`	`$sortSticky`	# `true`
`protected string`	`$category_sorttype`	# `'sort_order'`
`protected boolean`	`$category_sortdirection`	# `false`
`protected string`	`$page_sorttype`	# `'sort_order'`
`protected boolean`	`$page_sortdirection`	# `false`

Classes

Interfaces

Exceptions

Functions

Class Zenpage

Direct known subclasses

Deprecated

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Since