[geeklog-cvs] geeklog: Removed unused function and fixed phpDocumentor tags
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Thu May 21 09:47:36 EDT 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/bf07e94174ae
changeset: 7042:bf07e94174ae
user: Dirk Haun <dirk at haun-online.de>
date: Thu May 21 15:21:53 2009 +0200
description:
Removed unused function and fixed phpDocumentor tags
diffstat:
plugins/xmlsitemap/functions.inc | 66 ++++++++++++++++++--------------
1 files changed, 37 insertions(+), 29 deletions(-)
diffs (143 lines):
diff -r 7efa429d3a44 -r bf07e94174ae plugins/xmlsitemap/functions.inc
--- a/plugins/xmlsitemap/functions.inc Thu May 21 15:03:47 2009 +0200
+++ b/plugins/xmlsitemap/functions.inc Thu May 21 15:21:53 2009 +0200
@@ -138,6 +138,8 @@
/**
* Loads config infor with config.class.php
+*
+* @return mixed XMLSitemap config array or FALSE
*/
function XMLSMAP_loadConfig()
{
@@ -155,6 +157,11 @@
/**
* Return a string escaped for HTML output
+*
+* Escapes special characters so $str can be used in XML
+*
+* @param string $str string to encode
+* @return string encoded string
*/
function XMLSMAP_esc($str)
{
@@ -169,29 +176,11 @@
array( '<', '>', '&', '"', "'"),
$str
);
+
return htmlspecialchars($str, ENT_QUOTES, $encoding);
}
/**
-* Return a lang var
-*/
-function XMLSMAP_str($index, $noesc = FALSE)
-{
- global $LANG_XMLSMAP;
-
- if (isset($LANG_XMLSMAP[$index])) {
- if ($noesc) {
- return $LANG_XMLSMAP[$index];
- } else {
- return XMLSMAP_esc($LANG_XMLSMAP[$index]);
- }
- } else {
- COM_errorLog('XMLSMAP_str: undefined index: "' . $index . '"');
- return '(undefined)';
- }
-}
-
-/**
* Create XML sitemap(s) or update existing one(s)
*
* @param string $type plugin name
@@ -261,6 +250,12 @@
/**
* Callback function when an item was saved
+*
+* @param string $id (unused) ID of item being saved
+* @param string $type type of item ('article', 'staticpages', ...)
+* @param string $old_id (unused) previous ID of item, if != $id
+* @return void
+* @see PLG_itemSaved
*/
function plugin_itemsaved_xmlsitemap($id, $type, $old_id)
{
@@ -269,6 +264,11 @@
/**
* Callback function when an item was deleted
+*
+* @param string $id (unused) ID of item being deleted
+* @param string $type type of item ('article', 'staticpages', ...)
+* @return void
+* @see PLG_itemDeleted
*/
function plugin_itemdeleted_xmlsitemap($id, $type)
{
@@ -277,6 +277,10 @@
/**
* Callback function when this plugin is being enabled/disabled
+*
+* @param boolean $enable TRUE: we're being enabled, FALSE: disabled
+* @return void
+* @see PLG_enableStateChange
*/
function plugin_enablestatechange_xmlsitemap($enable)
{
@@ -298,8 +302,8 @@
/**
* Check if changed types, priorities, or frequencies are valid
*
-* @param name string - either 'types', 'priorities' or 'frequencies'
-* @return (void)
+* @param string $name either 'types', 'priorities' or 'frequencies'
+* @return void
*/
function XMLSITEMAP_checkChange($name)
{
@@ -367,9 +371,9 @@
/**
* Delete an old sitemap file and update $_TABLES['vars']
*
-* @param key string - config key
-* @param varname string - name field of $_TABLES['vars']
-* @return (void)
+* @param string $key config key
+* @param string $varname name field of $_TABLES['vars']
+* @return void
*/
function XMLSITEMAP_changeFile($key, $varname)
{
@@ -398,8 +402,10 @@
/**
* Callback function when configuration was changed
*
-* @param group string - 'Core' or 'xmlsitemap'
-* @param changes array of string - config var key
+* @param string $group 'Core' or 'xmlsitemap'
+* @param array $changes array of strings: config var key
+* @return void
+* @see PLG_configChange
*/
function plugin_configchange_xmlsitemap($group, $changes = array())
{
@@ -442,9 +448,11 @@
* Callback function when another plugin was installed/uninstalled/upgarded/
* enabled/disabled
*
-* @param type string - plugin name
-* @param status string - 'installed', 'uninstalled', 'upgraded', 'enabled',
-* or 'disabled'
+* @param string $type plugin name
+* @param string $status 'installed', 'uninstalled', 'upgraded', 'enabled',
+* or 'disabled'
+* @return void
+* @see PLG_pluginStateChange
*/
function plugin_pluginstatechange_xmlsitemap($type, $status)
{
More information about the geeklog-cvs
mailing list