Methods summary
public static
array
|
#
button( array $buttons )
creates the Utilities button to purge the static sitemap cache
creates the Utilities button to purge the static sitemap cache
Parameters
Returns
array
|
public static
string
|
#
echonl( string $string )
Simple helper function which simply outputs a string and ends it of with a new-line.
Simple helper function which simply outputs a string and ends it of with a new-line.
Parameters
Returns
string
|
public static
|
#
generateCacheFile( string $filename, string $data )
Generates a sitemap file.
Generates a sitemap file.
Parameters
- $filename
- How the file should be named. ".xml" is appended automatically
- $data
- The actual sitemap data as generated by the appropiate functions
|
public static
|
#
generateIndexCacheFile( )
Generates the sitemap index file that points to the individual sitemaps from the content of the sitemap cache.
It is always named "sitemapindex.xml"
Generates the sitemap index file that points to the individual sitemaps from the content of the sitemap cache.
It is always named "sitemapindex.xml"
|
public static
string
|
#
getChangefreq( string $changefreq = '' )
Checks the changefreq value if entered manually and makes sure it is only one of the supported regarding sitemap.org
Checks the changefreq value if entered manually and makes sure it is only one of the supported regarding sitemap.org
Parameters
- $changefreq
- One of the supported changefrequence values regarding sitemap.org. Default is empty or wrong is "daily".
Returns
string
|
public static
string
|
#
getDateformat( object $obj, string $option )
Gets the dateformat for images and albums only.
Gets the dateformat for images and albums only.
Parameters
- $obj
- image or album object
- $option
- "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
Returns
string
|
public static
string
|
#
getDBLimit( integer $items_per_sitemap = 2 )
Gets the limit and offset for the db queries for sitemap splitting.
Gets the limit and offset for the db queries for sitemap splitting.
Parameters
- $items_per_sitemap
- Number of items per sitemap
Returns
string
|
public static
|
|
public static
|
#
getAlbumList( object $obj, array & $albumlist )
Enter description here ...
Parameters
- $obj
- the starting point
- $albumlist
- the container for the results
|
public static
|
#
passAlbums( object $album )
gateway check for albums (no refinement of the criteria)
gateway check for albums (no refinement of the criteria)
Deprecated
Unused
Parameters
|
public static
|
#
passImages( object $album )
gateway function for images (screens out dynamic albums and password protected albums)
gateway function for images (screens out dynamic albums and password protected albums)
Deprecated
Unused
Parameters
|
public static
string
|
#
getAlbums( )
Places album and all of its album pages on one sitemap
Places album and all of its album pages on one sitemap
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.
Returns
string
|
public static
string
|
#
getImages( )
currently this splitts only sitemaps for albums and its images. Spliting the images itself requires a major rework...
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)
Returns
string
|
public static
|
#
getGoogleLoopIndex( $imageCount, $pageCount )
Helper function to get the loop index if the Google video extension is enabled
Helper function to get the loop index if the Google video extension is enabled
|
public static
string
|
#
getZenpagePages( )
Gets links to all Zenpage pages
Gets links to all Zenpage pages
Returns
string
|
public static
string
|
#
getZenpageNewsIndex( )
Gets links to the main Zenpage news index incl. pagination
Gets links to the main Zenpage news index incl. pagination
Returns
string
|
public static
string
|
#
getZenpageNewsArticles( string $changefreq,… )
Gets to the Zenpage news articles
Gets to the Zenpage news articles
Parameters
- $changefreq,…
- One of the supported changefrequence values regarding sitemap.org. Default is empty or wrong is "daily".
Returns
string
|
public static
string
|
#
getZenpageNewsCategories( )
Gets links to Zenpage news categories incl. pagination
Gets links to Zenpage news categories incl. pagination
Returns
string
|
public static
|
#
clearCache( )
Cleans out the cache folder.
Cleans out the cache folder.
|
public static
|
#
getISO8601Date( $date = '' )
Returns an ISO-8601 compliant date/time string for the given date/time.
While PHP5 can use the date format constant DATE_ISO8601, this function is designed to allow PHP4 use as well.
Eventually it can be deprecated, by:
1. Replacing parameterless references to this function with date(DATE_ISO8601)
2. Replacing references to this function in sitemap_getDateformat as documented there
Returns an ISO-8601 compliant date/time string for the given date/time.
While PHP5 can use the date format constant DATE_ISO8601, this function is designed to allow PHP4 use as well.
Eventually it can be deprecated, by: 1. Replacing parameterless references to this function with date(DATE_ISO8601) 2. Replacing references to this function in sitemap_getDateformat as documented there
|
public static
|
|
public static
string
|
#
getLastChangeDate( obj $obj, boolean $fulldate = false )
Gets the date as Y-m-d or if available last change date of $obj
Gets the date as Y-m-d or if available last change date of $obj
Parameters
- $obj
- $fulldate
- True to return the full date incl. time, otherwise the date only
Returns
string
|