com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]

Procedural File: lib_sitemap.php

Source Location: /_includes/lib_sitemap.php



Classes:

SitemapIndex
Describes a sitemap index.
Sitemap
Describes a sitemap.


Page Details:

A library that contains functions and classes related to the site's sitemap.

The sitemap is primarily used by indexing bots, e.g. googlebot.




Tags:

filesource:  Source Code for this file
license:  GNU Lesser General Public License
version:  $Revision: 1.2 $
author:  Andreas Launila


Includes:

require_once('common.php') [line 19]
For access to common constants and functions.






SITEMAP_FILES [line 44]

SITEMAP_FILES = "files"
Sitemap names, they have to be unique.



Tags:

access:  private

[ Top ]



SITEMAP_FORUM [line 45]

SITEMAP_FORUM = "forum"
Sitemap names, they have to be unique.



Tags:

access:  private

[ Top ]



SITEMAP_INDEX [line 27]

SITEMAP_INDEX = 'sitemap.xml'
The virtual location of the sitemap index file, the file that should contain the whole sitemap index.



Tags:

access:  private

[ Top ]



SITEMAP_INDEX_COUNTER [line 54]

SITEMAP_INDEX_COUNTER = 58
The counter that should be used to count the number of the times that the sitemap index has been requested.



Tags:

access:  private

[ Top ]



SITEMAP_NAMES [line 35]

SITEMAP_NAMES = 'sitemap_%s.xml'
The virtual locations that should be used for sitemap files. The name is a printf pattern that accepts one string parameter, the name. The string returned is the location relative to the site root.



Tags:

access:  private

[ Top ]



SITEMAP_NEWS [line 42]

SITEMAP_NEWS = "news"
Sitemap names, they have to be unique.



Tags:

access:  private

[ Top ]



SITEMAP_PROJECTS [line 43]

SITEMAP_PROJECTS = "projects"
Sitemap names, they have to be unique.



Tags:

access:  private

[ Top ]




formatSitemapElement [line 68]

string formatSitemapElement( string $loc, [integer $lastmod = false], [float $priority = false], [string $changefreq = false])

Formats the paramamters into a well-formed XML url element as specified by the google sitemap schema. The last three parameters are optional, they may be left out.



Tags:

return:  A well-formed XML url element.


Parameters

string   $loc   The url relative the root.
integer   $lastmod   The timestamp that describes the last point in time when the page was modified.
float   $priority   The priority of the page [0,1].
string   $changefreq   The change frequency as specified by the schema.
[ Top ]



notifyTableChanged [line 91]

void notifyTableChanged( string $table)

Notifies that the contents of a table has been altered. This should be called in order for the sitemaps to stay current.



Tags:

access:  public


Parameters

string   $table   The name of the table which's contents changed.
[ Top ]



Documentation generated on Sun, 16 Apr 2006 21:03:55 +0200 by phpDocumentor 1.3.0RC4