Procedural File: functions.inc

Source Location: /plugins/xmlsitemap/functions.inc

Page Details:

Implementation of the Plugin API for the XMLSitemap plugin

Includes:

include_once($langfile) [line 51]
Language file Include

include_once($_CONF['path'].'plugins/xmlsitemap/language/english.php') [line 53]

plugin_autouninstall_xmlsitemap [line 147]

array plugin_autouninstall_xmlsitemap(
)

Automatic uninstall function for plugins

[ Top ]

plugin_chkVersion_xmlsitemap [line 70]

string plugin_chkVersion_xmlsitemap(
)

Return the version for this plugin

Tags:

return:

VersionNo

[ Top ]

plugin_configchange_xmlsitemap [line 475]

void plugin_configchange_xmlsitemap(
string $group, [array $changes = array()])

Callback function when configuration was changed

Tags:

see:

PLG_configChange()

Parameters

string	$group	'Core' or 'xmlsitemap'
array	$changes	array of strings: config var key

[ Top ]

plugin_enablestatechange_xmlsitemap [line 317]

void plugin_enablestatechange_xmlsitemap(
boolean $enable)

Callback function when this plugin is being enabled/disabled

Tags:

see:

PLG_enableStateChange()

Parameters

boolean

$enable

TRUE: we're being enabled, FALSE: disabled

[ Top ]

plugin_itemdeleted_xmlsitemap [line 305]

void plugin_itemdeleted_xmlsitemap(
string $id, string $type)

Callback function when an item was deleted

Tags:

see:

PLG_itemDeleted()

Parameters

string	$id	(unused) ID of item being deleted
string	$type	type of item ('article', 'staticpages', ...)

[ Top ]

plugin_itemsaved_xmlsitemap [line 292]

void plugin_itemsaved_xmlsitemap(
string $id, string $type, string $old_id)

Callback function when an item was saved

Tags:

see:

PLG_itemSaved()

Parameters

string	$id	(unused) ID of item being saved
string	$type	type of item ('article', 'staticpages', ...)
string	$old_id	(unused) previous ID of item, if != $id

[ Top ]

plugin_pluginstatechange_xmlsitemap [line 522]

void plugin_pluginstatechange_xmlsitemap(
string $type, string $status)

Callback function when another plugin was installed/uninstalled/upgarded/ enabled/disabled

Tags:

see:

PLG_pluginStateChange()

Parameters

string	$type	plugin name
string	$status	'installed', 'uninstalled', 'upgraded', 'enabled', or 'disabled'

[ Top ]

plugin_upgrade_xmlsitemap [line 86]

boolean plugin_upgrade_xmlsitemap(
)

Upgrade the plugin

Tags:

return:

TRUE (= success)

[ Top ]

XMLSITEMAP_changeFile [line 443]

void XMLSITEMAP_changeFile(
string $key, string $varname)

Delete an old sitemap file and update $_TABLES['vars']

Parameters

string	$key	config key
string	$varname	name field of $_TABLES['vars']

[ Top ]

XMLSITEMAP_checkChange [line 340]

void XMLSITEMAP_checkChange(
string $name)

Check if changed types, priorities, or frequencies are valid

Parameters

string

$name

either 'types', 'priorities' or 'frequencies'

[ Top ]

XMLSITEMAP_removeSitemapFiles [line 603]

void XMLSITEMAP_removeSitemapFiles(
)

Remove the sitemap file(s)

[ Top ]

XMLSMAP_esc [line 198]

string XMLSMAP_esc(
string $str)

Return a string escaped for HTML output

Escapes special characters so $str can be used in XML

Tags:

return:

encoded string

Parameters

string

$str

string to encode

[ Top ]

XMLSMAP_loadConfig [line 176]

mixed XMLSMAP_loadConfig(
)

Loads config infor with config.class.php

Tags:

return:

XMLSitemap config array or FALSE

[ Top ]

XMLSMAP_update [line 223]

boolean XMLSMAP_update(
[string $type = NULL], [string $include = NULL], [string $exclude = NULL])

Create XML sitemap(s) or update existing one(s)

Tags:

return:

TRUE = success, FALSE = otherwise

Parameters

string	$type	plugin name
string	$include	plugin to add after install/enabled
string	$exclude	plugin to remove after uninstall/disabled

[ Top ]

Documentation generated on Sat, 11 Feb 2012 02:07:34 -0500 by phpDocumentor 1.4.3