Procedural File: deprecated-functions.php
Source Location: /zp-extensions/deprecated-functions.php
Classes
|
deprecated_functions
|
These functions have been removed from mainstream Zenphoto as they have been supplanted.
|
Functions
addPluginScript [line 394]
Parameters:
API Tags:
void addPluginScript(
$script
)
|
|
checkForPassword [line 780]
Parameters:
API Tags:
void checkForPassword(
$hint, $show
)
|
|
checkNewsAccess [line 646]
Checks if user is allowed access t the news article
Parameters:
|
$newsobj |
$newsobj: |
|
|
$hint |
&$hint: |
|
|
$show |
&$show: |
|
API Tags:
void checkNewsAccess(
$newsobj $newsobj, $hint &$hint, $show &$show
)
|
|
checkNewsCategoryPassword [line 658]
Checks if user is allowed to access News category
Parameters:
|
$catlink |
$catlink: |
|
|
$hint |
$hint: |
|
|
$show |
$show: |
|
API Tags:
void checkNewsCategoryPassword(
$catlink $catlink, $hint $hint, $show $show
)
|
|
checkPagePassword [line 620]
Checks for allowed access to a page
Parameters:
|
object |
$pageobj: |
|
|
string |
$hint: |
|
|
bool |
$show: |
|
|
|
&$hint: |
|
|
|
&$show: |
|
API Tags:
void checkPagePassword(
object $pageobj, &$hint, &$show, string $hint, bool $show
)
|
|
countArticles [line 1090]
Counts news articles, either all or by category or archive date, published or un-published
Parameters:
|
string |
$category: |
The categorylink of the category to count |
|
string |
$published: |
"published" for an published articles, "unpublished" for an unpublised articles, "all" for all articles |
|
|
$count_subcat_articles: |
|
array countArticles(
[string $category = ''], [string $published = 'published'], [ $count_subcat_articles = true]
)
|
|
countCombiNews [line 1475]
CombiNews Feature: Counts all news articles and all images
Parameters:
int countCombiNews(
[ $published = NULL]
)
|
|
deprecated_function_notify [line 51]
Parameters:
void deprecated_function_notify(
$use
)
|
|
generateCaptcha [line 1689]
Parameters:
void generateCaptcha(
&$img
)
|
|
getAllArticleDates [line 1214]
Retrieves a list of all unique years & months
Parameters:
|
bool |
$yearsonly: |
If set to true only the years' count is returned (Default false) |
array getAllArticleDates(
[bool $yearsonly = false]
)
|
|
getAllCategories [line 1559]
Gets all categories
array getAllCategories(
)
|
|
getAllSubalbums [line 386]
Parameters:
API Tags:
void getAllSubalbums(
[ $param = NULL]
)
|
|
getArticles [line 940]
Gets news articles titlelink either all or by category or by archive date.
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 |
$category: |
The categorylink of the category |
|
string |
$published: |
"published" for an published articles, "unpublished" for an unpublised articles, "sticky" for sticky articles, "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. |
array getArticles(
[int $articles_per_page = ''], [string $category = ''], [string $published = NULL], [boolean $ignorepagination = false], [string $sortorder = "date"], [string $sortdirection = "desc"], [bool $sticky = true]
)
|
|
getCategory [line 1543]
Gets a category titlelink by id
Parameters:
|
int |
$id: |
id of the category |
array getCategory(
int $id
)
|
|
getCategoryID [line 540]
Gets the id of a category
Parameters:
|
string |
$catlink: |
the categorylink of the category id to get |
API Tags:
int getCategoryID(
string $catlink
)
|
|
getCategoryLink [line 1527]
Gets the category link of a category
Parameters:
|
string |
$catname: |
the title of the category |
string getCategoryLink(
string $catname
)
|
|
getCategoryParentID [line 554]
Gets the parentid of a category
Parameters:
|
string |
$catlink: |
the categorylink of the category id to get |
API Tags:
int getCategoryParentID(
string $catlink
)
|
|
getCategorySortOrder [line 567]
Gets the sortorder of a category. Returns false if not.
Parameters:
|
string |
$catlink: |
the categorylink of the category sortorder to get |
API Tags:
string getCategorySortOrder(
string $catlink
)
|
|
getCategoryTitle [line 527]
Gets the category title of a category
Parameters:
|
string |
$catlink: |
the categorylink of the category |
API Tags:
string getCategoryTitle(
string $catlink
)
|
|
getCombiNews [line 1299]
Gets news articles and images of a gallery to show them together on the news section
NOTE: This function does not exclude articles that are password protected via a category
Parameters:
|
int |
$articles_per_page: |
The number of articles to get |
|
string |
$mode: |
"latestimages-thumbnail" "latestimages-thumbnail-customcrop" "latestimages-sizedimage" "latestalbums-thumbnail" "latestalbums-thumbnail-customcrop" "latestalbums-sizedimage" "latestimagesbyalbum-thumbnail" "latestimagesbyalbum-thumbnail-customcrop" "latestimagesbyalbum-sizedimage" "latestupdatedalbums-thumbnail" (for RSS and getLatestNews() used only) "latestupdatedalbums-thumbnail-customcrop" (for RSS and getLatestNews() used only) "latestupdatedalbums-sizedimage" (for RSS and getLatestNews() used only) NOTE: The "latestupdatedalbums" variants do NOT support pagination as required on the news loop! |
|
string |
$published: |
"published" for published articles, "unpublished" for un-published articles, "all" for all articles |
|
string |
$sortorder: |
id, date or mtime, only for latestimages-... modes |
|
bool |
$sticky: |
set to true to place "sticky" articles at the front of the list. |
array getCombiNews(
[int $articles_per_page = ''], [string $mode = ''], [string $published = NULL], [string $sortorder = ''], [bool $sticky = true]
)
|
|
getCommentDate [line 171]
Parameters:
API Tags:
void getCommentDate(
[ $format = NULL]
)
|
|
getCommentTime [line 190]
Parameters:
API Tags:
void getCommentTime(
[ $format = '%I:%M %p']
)
|
|
getCurrentAdminNewsPage [line 1262]
Get current news page for admin news pagination Addition needed because $_GET['page'] conflict with zenphoto could probably removed now...
int getCurrentAdminNewsPage(
)
|
|
getCurrentNewsCategory [line 670]
Gets the title of the currently selected news category
API Tags:
string getCurrentNewsCategory(
)
|
|
getCurrentNewsCategoryID [line 682]
Gets the id of the current selected news category
API Tags:
int getCurrentNewsCategoryID(
)
|
|
getCurrentNewsCategoryParentID [line 694]
Gets the parentid of the current selected news category
API Tags:
int getCurrentNewsCategoryParentID(
)
|
|
getCurrentNewsPage [line 1244]
Gets the current news page number
int getCurrentNewsPage(
)
|
|
getImageEXIFData [line 237]
getLimitAndOffset [line 1161]
Gets the LIMIT and OFFSET for the query that gets the news articles
Parameters:
|
int |
$articles_per_page: |
The number of articles to get |
|
bool |
$ignorepagination: |
If pagination should be ingored so always with the first is started (false is default) |
string getLimitAndOffset(
int $articles_per_page, [bool $ignorepagination = false]
)
|
|
getNewsContentShorten [line 772]
Shorten the content of any type of item and add the shorten indicator and readmore link set on the Zenpage plugin options. Helper function for getNewsContent() but usage of course not limited to that.
If there is nothing to shorten the content passed. The read more link is wrapped within <p class="readmorelink"></p>.
Parameters:
|
string |
$articlecontent: |
The article or page content or image/album description for CombiNews to shorten |
|
integer |
$shorten: |
The lenght the content should be shortened |
|
string |
$shortenindicator: |
The placeholder to mark the shortening (e.g."(...)"). If empty the Zenpage option for this is used. |
|
string |
$readmore: |
The text for the "read more" link. If empty the term set in Zenpage option is used. |
API Tags:
void getNewsContentShorten(
string $articlecontent, integer $shorten, [string $shortenindicator = ''], [string $readmore = '']
)
|
|
getNewsImageTags [line 333]
getNumSubalbums [line 378]
getPages [line 886]
Gets the titlelink and sort order for 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:
|
bool |
$published: |
TRUE for published or FALSE for all pages including un-published |
array getPages(
[bool $published = NULL]
)
|
|
getParentItems [line 860]
Gets the parent items recursivly to the item whose parentid is passed
Parameters:
|
string |
$mode: |
"pages" or "categories" |
|
int |
$parentid: |
The parentid of the page to get the parents of |
|
bool |
$initparents: |
If the |
|
|
&$parentid: |
|
array getParentItems(
[string $mode = 'pages'], &$parentid, [bool $initparents = true], int $parentid
)
|
|
getParentNewsCategories [line 515]
Gets the parent categories recursivly to the category whose parentid is passed
Parameters:
|
int |
$parentid: |
The parentid of the page to get the parents of |
|
bool |
$initparents: |
|
API Tags:
array getParentNewsCategories(
int $parentid, [bool $initparents = true]
)
|
|
getParentPages [line 581]
Gets the parent pages recursivly to the page whose parentid is passed
Parameters:
|
int |
$parentid: |
The parentid of the page to get the parents of |
|
bool |
$initparents: |
|
|
|
&$parentid: |
|
API Tags:
array getParentPages(
&$parentid, [bool $initparents = true], int $parentid
)
|
|
getRSSHeaderLink [line 1597]
Returns the RSS link for use in the HTML HEAD
Parameters:
|
string |
$option: |
type of RSS: "Gallery" feed for the whole gallery "Album" for only the album it is called from "Collection" for the album it is called from and all of its subalbums "Comments" for all comments "Comments-image" for comments of only the image it is called from "Comments-album" for comments of only the album it is called from |
|
string |
$linktext: |
title of the link |
|
string |
$lang: |
optional to display a feed link for a specific language. Enter the locale like "de_DE" (the locale must be installed on your Zenphoto to work of course). If empty the locale set in the admin option or the language selector (getOption('locale') is used. |
Information Tags:
string getRSSHeaderLink(
string $option, [string $linktext = ''], [string $lang = '']
)
|
|
getSubCategories [line 460]
Return an array of the catlinks of the subcategories of the requested category
Parameters:
|
string |
$catlink: |
the catlink of the sub categories to get of |
API Tags:
array getSubCategories(
string $catlink
)
|
|
getTotalArticles [line 1190]
Returns the articles count
getZenpageHitcounter [line 83]
Parameters:
API Tags:
| Deprecated: | Enter description here ... |
void getZenpageHitcounter(
[$mode $mode = ""], [$obj $obj = NULL]
)
|
|
getZenpageRSSHeaderLink [line 1653]
Returns the RSS link for use in the HTML HEAD
Parameters:
|
string |
$option: |
type of RSS: "News" feed for all news articles "Category" for only the news articles of a specific category "NewsWithImages" for all news articles and latest images |
|
string |
$categorylink: |
The specific category you want a RSS feed from (only 'Category' mode) |
|
string |
$linktext: |
title of the link |
|
string |
$lang: |
optional to display a feed link for a specific language (currently works for latest images only). Enter the locale like "de_DE" (the locale must be installed on your Zenphoto to work of course). If empty the locale set in the admin option or the language selector (getOption('locale') is used. |
string getZenpageRSSHeaderLink(
[string $option = ''], [string $categorylink = ''], [string $linktext = ''], [string $lang = '']
)
|
|
hitcounter [line 199]
Parameters:
API Tags:
void hitcounter(
[ $option = 'image'], [ $viewonly = false], [ $id = NULL]
)
|
|
inNewsCategory [line 707]
Checks if an article is in a category and returns TRUE or FALSE
Parameters:
|
string |
$catlink: |
The titlelink of a category |
API Tags:
bool inNewsCategory(
string $catlink
)
|
|
inProtectedNewsCategory [line 477]
Checks if an article (not CombiNews gallery items!) is in a password protected category and returns TRUE or FALSE NOTE: This function does not check if the password has been entered! Use checkAccess() for that.
Parameters:
|
bool |
$checkProtection: |
If set to TRUE (default) this check if the article is actually protected (remember only articles that are in the protected category only are!). If set to FALSE it simply checks if it is in an otherwise protected category at all |
|
obj |
$articleobj: |
Optional news article object to check directly, if empty the current news article is checked if available |
API Tags:
bool inProtectedNewsCategory(
[obj $articleobj = NULL], [bool $checkProtection = true]
)
|
|
inSubNewsCategoryOf [line 720]
Checks if an article is in a sub category of $catlink
Parameters:
|
string |
$catlink: |
The titlelink of a category |
API Tags:
bool inSubNewsCategoryOf(
string $catlink
)
|
|
isMyAlbum [line 443]
Parameters:
API Tags:
void isMyAlbum(
$albumname, $action
)
|
|
isMyNews [line 633]
Checks if user is news author
Parameters:
|
object |
$newsobj: |
News object being checked |
|
$action |
$action: |
|
API Tags:
void isMyNews(
object $newsobj, $action $action
)
|
|
isMyPage [line 606]
Checks if user is author of page
Parameters:
|
object |
$pageobj: |
|
|
bit |
$action: |
|
API Tags:
void isMyPage(
[object $pageobj = NULL], bit $action
)
|
|
isProtectedAlbum [line 1573]
Checks if the album is password protected
Parameters:
void isProtectedAlbum(
[object $album = NULL]
)
|
|
isProtectedNewsCategory [line 496]
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 checkNewsCategoryPassword() for that.
Parameters:
|
string |
$catlink: |
The optional categorylink of a category, if empty the current category is checked if available |
API Tags:
bool isProtectedNewsCategory(
[string $catlink = '']
)
|
|
isProtectedPage [line 593]
Checks if the page is itself password protected or is inheriting protection from a parent pages.
NOTE: This function does only check if a password is set not if it has been entered! Use checkPagePassword() for that.
Parameters:
|
obj |
$pageobj: |
Optional page object to test directly, otherwise the current page is checked if available. |
API Tags:
void isProtectedPage(
[obj $pageobj = NULL]
)
|
|
isSubNewsCategoryOf [line 733]
Checks if the current news category is a sub category of $catlink
Parameters:
|
string |
$catlink: |
The categorylink of a category |
API Tags:
bool isSubNewsCategoryOf(
string $catlink
)
|
|
my_truncate_string [line 224]
Parameters:
API Tags:
void my_truncate_string(
$string, $length
)
|
|
normalizeColumns [line 423]
Parameters:
|
|
$albumColumns: |
|
|
|
$imageColumns: |
|
API Tags:
void normalizeColumns(
[ $albumColumns = NULL], [ $imageColumns = NULL]
)
|
|
printAlbumMap [line 788]
Parameters:
|
|
$zoomlevel: |
|
|
|
$defaultmaptype: |
|
|
|
$width: |
|
|
|
$height: |
|
|
|
$text: |
|
|
|
$toggle: |
|
|
|
$id: |
|
|
|
$firstPageImages: |
|
|
|
$mapselections: |
|
|
|
$addwiki: |
|
|
|
$background: |
|
|
|
$mapcontrol: |
|
|
|
$maptypecontrol: |
|
|
|
$customJS: |
|
API Tags:
void printAlbumMap(
[ $zoomlevel = NULL], [ $defaultmaptype = NULL], [ $width = NULL], [ $height = NULL], [ $text = NULL], [ $toggle = true], [ $id = 'googlemap'], [ $firstPageImages = NULL], [ $mapselections = NULL], [ $addwiki = NULL], [ $background = NULL], [ $mapcontrol = NULL], [ $maptypecontrol = NULL], [ $customJS = NULL]
)
|
|
printAlbumPlace [line 256]
printAlbumRating [line 138]
Parameters:
API Tags:
void printAlbumRating(
[ $object = NULL]
)
|
|
printCustomSizedImageMaxHeight [line 159]
Parameters:
API Tags:
void printCustomSizedImageMaxHeight(
$maxheight
)
|
|
printEditable [line 264]
Parameters:
|
|
$context: |
|
|
|
$field: |
|
|
|
$editable: |
|
|
|
$editclass: |
|
|
|
$messageIfEmpty: |
|
|
|
$convertBR: |
|
|
|
$override: |
|
|
|
$label: |
|
API Tags:
void printEditable(
$context, $field, [ $editable = NULL], [ $editclass = 'unspecified'], [ $messageIfEmpty = true], [ $convertBR = false], [ $override = false], [ $label = '']
)
|
|
printImageEXIFData [line 148]
API Tags:
void printImageEXIFData(
)
|
|
printImageMap [line 796]
Parameters:
|
|
$zoomlevel: |
|
|
|
$defaultmaptype: |
|
|
|
$width: |
|
|
|
$height: |
|
|
|
$text: |
|
|
|
$toggle: |
|
|
|
$id: |
|
|
|
$mapselections: |
|
|
|
$addwiki: |
|
|
|
$background: |
|
|
|
$mapcontrol: |
|
|
|
$maptypecontrol: |
|
|
|
$customJS: |
|
API Tags:
void printImageMap(
[ $zoomlevel = NULL], [ $defaultmaptype = NULL], [ $width = NULL], [ $height = NULL], [ $text = NULL], [ $toggle = true], [ $id = 'googlemap'], [ $mapselections = NULL], [ $addwiki = NULL], [ $background = NULL], [ $mapcontrol = NULL], [ $maptypecontrol = NULL], [ $customJS = NULL]
)
|
|
printImageRating [line 128]
Parameters:
API Tags:
| Deprecated: | Enter description here ... |
void printImageRating(
[$object $object = NULL]
)
|
|
printNewsImageTags [line 346]
Parameters:
|
|
$option: |
|
|
|
$preText: |
|
|
|
$class: |
|
|
|
$separator: |
|
|
|
$editable: |
|
API Tags:
void printNewsImageTags(
[ $option = 'links'], [ $preText = NULL], [ $class = 'taglist'], [ $separator = ', '], [ $editable = TRUE]
)
|
|
printNewsReadMoreLink [line 746]
Prints the read more link or if using CombiNews feature also the link to the image.php gallery page as a full html link
Parameters:
|
string |
$readmore: |
The readmore text to be shown for the full news article link. If empty the option setting is used. |
API Tags:
string printNewsReadMoreLink(
[string $readmore = '']
)
|
|
printParentPagesBreadcrumb [line 435]
Parameters:
API Tags:
void printParentPagesBreadcrumb(
[ $before = ''], [ $after = '']
)
|
|
printPreloadScript [line 811]
API Tags:
void printPreloadScript(
)
|
|
processExpired [line 844]
Un-publishes pages/news whose expiration date has been reached
Parameters:
void processExpired(
$table
)
|
|
rewrite_path_zenpage [line 321]
Parameters:
API Tags:
void rewrite_path_zenpage(
[ $rewrite = ''], [ $plain = '']
)
|
|
setupAllowedMaps [line 804]
Parameters:
|
|
$defaultmap: |
|
|
|
$allowedmaps: |
|
API Tags:
void setupAllowedMaps(
$defaultmap, $allowedmaps
)
|
|
zenpageHitcounter [line 276]
Parameters:
API Tags:
void zenpageHitcounter(
[ $option = 'pages'], [ $viewonly = false], [ $id = NULL]
)
|
|
|
|
Twitter
Youtube