ZenphotoCMS 1.6.3

sitemap

Sitemap class

Table of Contents

Methods

button()  : array<string|int, mixed>
creates the Utilities button to purge the static sitemap cache
clearCache()  : mixed
Cleans out the cache folder.
echonl()  : string
Simple helper function which simply outputs a string and ends it of with a new-line.
generateCacheFile()  : mixed
Generates a sitemap file.
generateIndexCacheFile()  : mixed
Generates the sitemap index file that points to the individual sitemaps from the content of the sitemap cache.
getAlbumList()  : mixed
Enter description here .
getAlbums()  : string
Places album and all of its album pages on one sitemap
getChangefreq()  : string
Checks the changefreq value if entered manually and makes sure it is only one of the supported regarding sitemap.org
getDateformat()  : string
Gets the dateformat for images and albums only.
getDBLimit()  : string
Gets the limit and offset for the db queries for sitemap splitting.
getGoogleImageVideoExtras()  : string
Helper function to get the image/video extra entries for albums if the Google video extension is enabled
getGoogleLoopIndex()  : mixed
Helper function to get the loop index if the Google video extension is enabled
getImages()  : string
currently this splitts only sitemaps for albums and its images. Spliting the images itself requires a major rework... Gets links to all images for all albums (album by album)
getIndexLinks()  : mixed
getISO8601Date()  : mixed
Returns an ISO-8601 compliant date/time string for the given date/time.
getLastChangeDate()  : string
Gets the date as Y-m-d or if available last change date of $obj
getZenpageNewsArticles()  : string
Gets to the Zenpage news articles
getZenpageNewsCategories()  : string
Gets links to Zenpage news categories incl. pagination
getZenpageNewsIndex()  : string
Gets links to the main Zenpage news index incl. pagination
getZenpagePages()  : string
Gets links to all Zenpage pages
passAlbums()  : mixed
gateway check for albums (no refinement of the criteria)
passImages()  : mixed
gateway function for images (screens out dynamic albums and password protected albums)
printAvailableSitemaps()  : mixed

Methods

button()

creates the Utilities button to purge the static sitemap cache

public static button(array<string|int, mixed> $buttons) : array<string|int, mixed>
Parameters
$buttons : array<string|int, mixed>
Return values
array<string|int, mixed>

clearCache()

Cleans out the cache folder.

public static clearCache() : mixed

echonl()

Simple helper function which simply outputs a string and ends it of with a new-line.

public static echonl(string $string) : string
Parameters
$string : string

text string

Return values
string

generateCacheFile()

Generates a sitemap file.

public static generateCacheFile(string $filename, string $data) : mixed
Parameters
$filename : string

How the file should be named. ".xml" is appended automatically

$data : string

The actual sitemap data as generated by the appropiate functions

generateIndexCacheFile()

Generates the sitemap index file that points to the individual sitemaps from the content of the sitemap cache.

public static generateIndexCacheFile() : mixed

It is always named "sitemapindex.xml"

getAlbumList()

Enter description here .

public static getAlbumList(object $obj, array<string|int, mixed> &$albumlist) : mixed

..

Parameters
$obj : object

the starting point

$albumlist : array<string|int, mixed>

the container for the results

getAlbums()

Places album and all of its album pages on one sitemap

public static getAlbums() : string

Gets links to all albums incl. pagination and if the Google image video extension is enabled for images using this as well. This is independent from the images fetched by getSitemapImages().

NOTE: Using the Google extension is currently NOT recommended if you have a huge gallery.

Return values
string

getChangefreq()

Checks the changefreq value if entered manually and makes sure it is only one of the supported regarding sitemap.org

public static getChangefreq([string $changefreq = '' ]) : string
Parameters
$changefreq : string = ''

One of the supported changefrequence values regarding sitemap.org. Default is empty or wrong is "daily".

Return values
string

getDateformat()

Gets the dateformat for images and albums only.

public static getDateformat(object $obj, string $option) : string
Parameters
$obj : object

image or album object

$option : string

"date" or "mtime". If "mtime" is discovered to be not set, the date values is taken instead so we don't get 1970-01-10 dates

Return values
string

getDBLimit()

Gets the limit and offset for the db queries for sitemap splitting.

public static getDBLimit([int $items_per_sitemap = 2 ]) : string
Parameters
$items_per_sitemap : int = 2

Number of items per sitemap

Return values
string

getGoogleImageVideoExtras()

Helper function to get the image/video extra entries for albums if the Google video extension is enabled

public static getGoogleImageVideoExtras(mixed $albumobj, mixed $imageobj, mixed $locale) : string
Parameters
$albumobj : mixed
$imageobj : mixed
$locale : mixed
Return values
string

getGoogleLoopIndex()

Helper function to get the loop index if the Google video extension is enabled

public static getGoogleLoopIndex(mixed $imageCount, mixed $pageCount) : mixed
Parameters
$imageCount : mixed
$pageCount : mixed

getImages()

currently this splitts only sitemaps for albums and its images. Spliting the images itself requires a major rework... Gets links to all images for all albums (album by album)

public static getImages() : string
Return values
string

getISO8601Date()

Returns an ISO-8601 compliant date/time string for the given date/time.

public static getISO8601Date([mixed $date = '' ]) : mixed
Parameters
$date : mixed = ''

getLastChangeDate()

Gets the date as Y-m-d or if available last change date of $obj

public static getLastChangeDate(obj $obj[, bool $fulldate = false ]) : string
Parameters
$obj : obj
$fulldate : bool = false

True to return the full date incl. time, otherwise the date only

Return values
string

getZenpageNewsArticles()

Gets to the Zenpage news articles

public static getZenpageNewsArticles() : string
Return values
string

getZenpageNewsCategories()

Gets links to Zenpage news categories incl. pagination

public static getZenpageNewsCategories() : string
Return values
string

getZenpageNewsIndex()

Gets links to the main Zenpage news index incl. pagination

public static getZenpageNewsIndex() : string
Return values
string

getZenpagePages()

Gets links to all Zenpage pages

public static getZenpagePages() : string
Return values
string

passAlbums()

gateway check for albums (no refinement of the criteria)

public static passAlbums(object $album) : mixed
Parameters
$album : object
Tags
deprecated

Unused

passImages()

gateway function for images (screens out dynamic albums and password protected albums)

public static passImages(object $album) : mixed
Parameters
$album : object
Tags
deprecated

Unused

printAvailableSitemaps()

public static printAvailableSitemaps() : mixed

        
On this page

Search results