mambax7 / references

index.php

Indentation +38 added lines, -38 removed lines

@@ -41,9 +41,9 @@ 
 $xoTheme->addScript(REFERENCES_JS_URL . 'js/mootools-1.2-more.js');
 
 if (isset($xoopsConfig) && file_exists(REFERENCES_PATH . 'language/' . $xoopsConfig['language'] . '/slimbox.js')) {
-    $xoTheme->addScript(REFERENCES_URL . 'language/' . $xoopsConfig['language'] . '/slimbox.js');
+	$xoTheme->addScript(REFERENCES_URL . 'language/' . $xoopsConfig['language'] . '/slimbox.js');
 } else {
-    $xoTheme->addScript(REFERENCES_JS_URL . 'js/slimbox.js');
+	$xoTheme->addScript(REFERENCES_JS_URL . 'js/slimbox.js');
 }
 
 $categories       = $h_references_categories->getCategories();
@@ -63,42 +63,42 @@ 
 $refFounded              = false;
 $mostRecentReferenceDate = 0;
 if ($limit > 0) {
-    $uniqueCategories = $h_references_articles->getDistinctCategoriesIds();
-    foreach ($uniqueCategories as $categoryId) {
-        $items          = array();
-        $items          = $h_references_articles->getRecentArticles($start, $limit, references_utils::getModuleOption('sort_field'), references_utils::getModuleOption('sort_order'), true, $categoryId);
-        $categoryTitle  = isset($categories[$categoryId]) ? $categories[$categoryId]->getVar('category_title') : '';
-        $categoryWeight = isset($categories[$categoryId]) ? $categories[$categoryId]->getVar('category_weight') : 0;
-        if (count($items) > 0) {
-            foreach ($items as $item) {
-                $articleData = array();
-                $articleData = $item->toArray();
-                if ($item->getVar('article_id') == $article_id) {
-                    $xoopsTpl->assign('defaultArticle', $index);
-                    $refFounded = true;
-                }
-                ++$index;
-                $articleData['article_category_id']                                          = $categoryId;
-                $articleData['article_category_title']                                       = $categoryTitle;
-                $articleData['article_category_weight']                                      = $categoryWeight;
-                $categoriesForTemplate[$categoryWeight . '-' . $categoryId]['articles'][]    = $articleData;
-                $categoriesForTemplate[$categoryWeight . '-' . $categoryId]['categoryTitle'] = $categoryTitle;
-                $categoriesForTemplate[$categoryWeight . '-' . $categoryId]['categoryId']    = $categoryId;
-                if ($item->getVar('article_timestamp') > $mostRecentReferenceDate) {
-                    $mostRecentReferenceDate = $item->getVar('article_timestamp');
-                    $lastTitle               = strip_tags($item->getVar('article_title', 'n')) . ', ' . $item->getVar('article_date');
-                    $lastKeywords            = strip_tags($item->getVar('article_text', 'n'));
-                }
-            }
-        }
-    }
-    if (!$refFounded) {
-        $xoopsTpl->assign('defaultArticle', 0);
-    }
-    if (count($categoriesForTemplate) > 0) {
-        ksort($categoriesForTemplate);
-    }
-    $xoopsTpl->assign('categories', $categoriesForTemplate);
+	$uniqueCategories = $h_references_articles->getDistinctCategoriesIds();
+	foreach ($uniqueCategories as $categoryId) {
+		$items          = array();
+		$items          = $h_references_articles->getRecentArticles($start, $limit, references_utils::getModuleOption('sort_field'), references_utils::getModuleOption('sort_order'), true, $categoryId);
+		$categoryTitle  = isset($categories[$categoryId]) ? $categories[$categoryId]->getVar('category_title') : '';
+		$categoryWeight = isset($categories[$categoryId]) ? $categories[$categoryId]->getVar('category_weight') : 0;
+		if (count($items) > 0) {
+			foreach ($items as $item) {
+				$articleData = array();
+				$articleData = $item->toArray();
+				if ($item->getVar('article_id') == $article_id) {
+					$xoopsTpl->assign('defaultArticle', $index);
+					$refFounded = true;
+				}
+				++$index;
+				$articleData['article_category_id']                                          = $categoryId;
+				$articleData['article_category_title']                                       = $categoryTitle;
+				$articleData['article_category_weight']                                      = $categoryWeight;
+				$categoriesForTemplate[$categoryWeight . '-' . $categoryId]['articles'][]    = $articleData;
+				$categoriesForTemplate[$categoryWeight . '-' . $categoryId]['categoryTitle'] = $categoryTitle;
+				$categoriesForTemplate[$categoryWeight . '-' . $categoryId]['categoryId']    = $categoryId;
+				if ($item->getVar('article_timestamp') > $mostRecentReferenceDate) {
+					$mostRecentReferenceDate = $item->getVar('article_timestamp');
+					$lastTitle               = strip_tags($item->getVar('article_title', 'n')) . ', ' . $item->getVar('article_date');
+					$lastKeywords            = strip_tags($item->getVar('article_text', 'n'));
+				}
+			}
+		}
+	}
+	if (!$refFounded) {
+		$xoopsTpl->assign('defaultArticle', 0);
+	}
+	if (count($categoriesForTemplate) > 0) {
+		ksort($categoriesForTemplate);
+	}
+	$xoopsTpl->assign('categories', $categoriesForTemplate);
 }
 
 $xoopsTpl->assign('isAdmin', references_utils::isAdmin());

blocks/references_last_news.php

Indentation +40 added lines, -40 removed lines

@@ -26,26 +26,26 @@ 
  */
 function b_references_last_news_show($options)
 {
-    global $xoopsConfig;
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    $block = array();
-    $start = 0;
-    $limit = (int)$options[0];
-    if ($limit > 0) {
-        $items      = array();
-        $categories = array();
-        if (is_array($options) && count($options) > 1) {
-            $categories = array_slice($options, 1);
-        }
-        $items = $h_references_articles->getRecentArticles($start, $limit, 'article_timestamp', 'DESC', true, $categories);
-        if (count($items) > 0) {
-            foreach ($items as $item) {
-                $block['block_last_news'][] = $item->toArray();
-            }
-        }
-    }
+	global $xoopsConfig;
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	$block = array();
+	$start = 0;
+	$limit = (int)$options[0];
+	if ($limit > 0) {
+		$items      = array();
+		$categories = array();
+		if (is_array($options) && count($options) > 1) {
+			$categories = array_slice($options, 1);
+		}
+		$items = $h_references_articles->getRecentArticles($start, $limit, 'article_timestamp', 'DESC', true, $categories);
+		if (count($items) > 0) {
+			foreach ($items as $item) {
+				$block['block_last_news'][] = $item->toArray();
+			}
+		}
+	}
 
-    return $block;
+	return $block;
 }
 
 /**
@@ -56,26 +56,26 @@ 
  */
 function b_references_last_news_edit($options)
 {
-    global $xoopsConfig;
-    include XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    $handlers   = references_handler::getInstance();
-    $categories = $handlers->h_references_categories->getListArray();
-    $form       = '';
-    $form .= "<table border='0'>";
-    $form .= '<tr><td>' . _MB_REFERENCES_ITEMS_COUNT . "</td><td><input type='text' name='options[]' id='options' value='" . $options[0] . "' /></td></tr>\n";
-    $form .= '<tr><td>' . _MB_REFERENCES_CATEGORIES . "</td><td><select name='options[]' multiple='multiple'>";
-    $size = count($options);
-    foreach ($categories as $Idcategory => $categoryName) {
-        $sel = '';
-        for ($i = 1; $i < $size; ++$i) {
-            if ($options[$i] == $Idcategory) {
-                $sel = " selected='selected'";
-            }
-        }
-        $form .= "<option value='$Idcategory' $sel>$categoryName</option>";
-    }
-    $form .= "</select></td></tr>\n";
-    $form .= '</table>';
+	global $xoopsConfig;
+	include XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	$handlers   = references_handler::getInstance();
+	$categories = $handlers->h_references_categories->getListArray();
+	$form       = '';
+	$form .= "<table border='0'>";
+	$form .= '<tr><td>' . _MB_REFERENCES_ITEMS_COUNT . "</td><td><input type='text' name='options[]' id='options' value='" . $options[0] . "' /></td></tr>\n";
+	$form .= '<tr><td>' . _MB_REFERENCES_CATEGORIES . "</td><td><select name='options[]' multiple='multiple'>";
+	$size = count($options);
+	foreach ($categories as $Idcategory => $categoryName) {
+		$sel = '';
+		for ($i = 1; $i < $size; ++$i) {
+			if ($options[$i] == $Idcategory) {
+				$sel = " selected='selected'";
+			}
+		}
+		$form .= "<option value='$Idcategory' $sel>$categoryName</option>";
+	}
+	$form .= "</select></td></tr>\n";
+	$form .= '</table>';
 
-    return $form;
+	return $form;
 }

blocks/references_block_tag.php

Indentation +24 added lines, -24 removed lines

@@ -22,44 +22,44 @@
  */
 function references_tag_block_cloud_show($options)
 {
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    if (!references_utils::tagModuleExists()) {
-        return false;
-    }
-    require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	if (!references_utils::tagModuleExists()) {
+		return false;
+	}
+	require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
 
-    return tag_block_cloud_show($options, 'references');
+	return tag_block_cloud_show($options, 'references');
 }
 
 function references_tag_block_cloud_edit($options)
 {
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    if (!references_utils::tagModuleExists()) {
-        return false;
-    }
-    require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	if (!references_utils::tagModuleExists()) {
+		return false;
+	}
+	require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
 
-    return tag_block_cloud_edit($options);
+	return tag_block_cloud_edit($options);
 }
 
 function references_tag_block_top_show($options)
 {
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    if (!references_utils::tagModuleExists()) {
-        return false;
-    }
-    require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	if (!references_utils::tagModuleExists()) {
+		return false;
+	}
+	require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
 
-    return tag_block_top_show($options, 'references');
+	return tag_block_top_show($options, 'references');
 }
 
 function references_tag_block_top_edit($options)
 {
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    if (!references_utils::tagModuleExists()) {
-        return false;
-    }
-    require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	if (!references_utils::tagModuleExists()) {
+		return false;
+	}
+	require_once XOOPS_ROOT_PATH . '/modules/tag/blocks/block.php';
 
-    return tag_block_top_edit($options);
+	return tag_block_top_edit($options);
 }

blocks/references_random_news.php

Indentation +42 added lines, -42 removed lines

@@ -26,28 +26,28 @@ 
  */
 function b_references_random_news_show($options)
 {
-    global $xoopsConfig;
-    require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    $block = array();
-    $start = 0;
-    $limit = (int)$options[0];
-    if ($limit > 0) {
-        $items = array();
-        $h_references_articles->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'caching' => false, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
-        $categories = array();
-        if (is_array($options) && count($options) > 1) {
-            $categories = array_slice($options, 1);
-        }
-        $items = $h_references_articles->getRecentArticles($start, $limit, 'RAND(), NOW()', 'DESC', true, $categories);
-        $h_references_articles->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'caching' => true, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
-        if (count($items) > 0) {
-            foreach ($items as $item) {
-                $block['block_random_news'][] = $item->toArray();
-            }
-        }
-    }
+	global $xoopsConfig;
+	require XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	$block = array();
+	$start = 0;
+	$limit = (int)$options[0];
+	if ($limit > 0) {
+		$items = array();
+		$h_references_articles->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'caching' => false, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
+		$categories = array();
+		if (is_array($options) && count($options) > 1) {
+			$categories = array_slice($options, 1);
+		}
+		$items = $h_references_articles->getRecentArticles($start, $limit, 'RAND(), NOW()', 'DESC', true, $categories);
+		$h_references_articles->setCachingOptions(array('cacheDir' => REFERENCES_CACHE_PATH, 'caching' => true, 'lifeTime' => null, 'automaticSerialization' => true, 'fileNameProtection' => false));
+		if (count($items) > 0) {
+			foreach ($items as $item) {
+				$block['block_random_news'][] = $item->toArray();
+			}
+		}
+	}
 
-    return $block;
+	return $block;
 }
 
 /**
@@ -58,26 +58,26 @@ 
  */
 function b_references_random_news_edit($options)
 {
-    global $xoopsConfig;
-    include XOOPS_ROOT_PATH . '/modules/references/include/common.php';
-    $handlers   = references_handler::getInstance();
-    $categories = $handlers->h_references_categories->getListArray();
-    $form       = '';
-    $form .= "<table border='0'>";
-    $form .= '<tr><td>' . _MB_REFERENCES_ITEMS_COUNT . "</td><td><input type='text' name='options[]' id='options' value='" . $options[0] . "' /></td></tr>\n";
-    $form .= '<tr><td>' . _MB_REFERENCES_CATEGORIES . "</td><td><select name='options[]' multiple='multiple'>";
-    $size = count($options);
-    foreach ($categories as $Idcategory => $categoryName) {
-        $sel = '';
-        for ($i = 1; $i < $size; ++$i) {
-            if ($options[$i] == $Idcategory) {
-                $sel = " selected='selected'";
-            }
-        }
-        $form .= "<option value='$Idcategory' $sel>$categoryName</option>";
-    }
-    $form .= "</select></td></tr>\n";
-    $form .= '</table>';
+	global $xoopsConfig;
+	include XOOPS_ROOT_PATH . '/modules/references/include/common.php';
+	$handlers   = references_handler::getInstance();
+	$categories = $handlers->h_references_categories->getListArray();
+	$form       = '';
+	$form .= "<table border='0'>";
+	$form .= '<tr><td>' . _MB_REFERENCES_ITEMS_COUNT . "</td><td><input type='text' name='options[]' id='options' value='" . $options[0] . "' /></td></tr>\n";
+	$form .= '<tr><td>' . _MB_REFERENCES_CATEGORIES . "</td><td><select name='options[]' multiple='multiple'>";
+	$size = count($options);
+	foreach ($categories as $Idcategory => $categoryName) {
+		$sel = '';
+		for ($i = 1; $i < $size; ++$i) {
+			if ($options[$i] == $Idcategory) {
+				$sel = " selected='selected'";
+			}
+		}
+		$form .= "<option value='$Idcategory' $sel>$categoryName</option>";
+	}
+	$form .= "</select></td></tr>\n";
+	$form .= '</table>';
 
-    return $form;
+	return $form;
 }

rss.php

Indentation +47 added lines, -47 removed lines

@@ -28,11 +28,11 @@ 
 @$xoopsLogger->activated = false;
 
 if (!references_utils::getModuleOption('use_rss')) {
-    exit(_ERRORS);
+	exit(_ERRORS);
 }
 
 if (function_exists('mb_http_output')) {
-    mb_http_output('pass');
+	mb_http_output('pass');
 }
 $charset = 'utf-8';
 header('Content-Type:text/xml; charset=' . $charset);
@@ -42,52 +42,52 @@ 
 $tpl->xoops_setCacheTime(references_utils::getModuleOption('rss_cache_time'));    // Temps de cache en secondes
 $uid = references_utils::getCurrentUserID();
 if (!$tpl->is_cached('db:references_rss.tpl', $uid)) {
-    $categoryTitle = '';
-    global $xoopsConfig;
-    $sitename = htmlspecialchars($xoopsConfig['sitename'], ENT_QUOTES);
-    $email    = $xoopsConfig['adminmail'];
-    $slogan   = htmlspecialchars($xoopsConfig['slogan'], ENT_QUOTES);
+	$categoryTitle = '';
+	global $xoopsConfig;
+	$sitename = htmlspecialchars($xoopsConfig['sitename'], ENT_QUOTES);
+	$email    = $xoopsConfig['adminmail'];
+	$slogan   = htmlspecialchars($xoopsConfig['slogan'], ENT_QUOTES);
 
-    $tpl->assign('charset', $charset);
-    $tpl->assign('channel_title', xoops_utf8_encode($sitename));
-    $tpl->assign('channel_link', XOOPS_URL . '/');
-    $tpl->assign('channel_desc', xoops_utf8_encode($slogan));
-    $tpl->assign('channel_lastbuild', formatTimestamp(time(), 'rss'));
-    $tpl->assign('channel_webmaster', xoops_utf8_encode($email));
-    $tpl->assign('channel_editor', xoops_utf8_encode($email));
-    $tpl->assign('channel_category', xoops_utf8_encode($categoryTitle));
-    $tpl->assign('channel_generator', xoops_utf8_encode(references_utils::getModuleName()));
-    $tpl->assign('channel_language', _LANGCODE);
-    $tpl->assign('image_url', XOOPS_URL . '/assets/images/logo.gif');
-    $dimention = getimagesize(XOOPS_ROOT_PATH . '/assets/images/logo.gif');
-    if (empty($dimention[0])) {
-        $width = 88;
-    } else {
-        $width = ($dimention[0] > 144) ? 144 : $dimention[0];
-    }
-    if (empty($dimention[1])) {
-        $height = 31;
-    } else {
-        $height = ($dimention[1] > 400) ? 400 : $dimention[1];
-    }
-    $tpl->assign('image_width', $width);
-    $tpl->assign('image_height', $height);
-    $start = 0;
-    $limit = references_utils::getModuleOption('nb_perpage');
-    $items = array();
+	$tpl->assign('charset', $charset);
+	$tpl->assign('channel_title', xoops_utf8_encode($sitename));
+	$tpl->assign('channel_link', XOOPS_URL . '/');
+	$tpl->assign('channel_desc', xoops_utf8_encode($slogan));
+	$tpl->assign('channel_lastbuild', formatTimestamp(time(), 'rss'));
+	$tpl->assign('channel_webmaster', xoops_utf8_encode($email));
+	$tpl->assign('channel_editor', xoops_utf8_encode($email));
+	$tpl->assign('channel_category', xoops_utf8_encode($categoryTitle));
+	$tpl->assign('channel_generator', xoops_utf8_encode(references_utils::getModuleName()));
+	$tpl->assign('channel_language', _LANGCODE);
+	$tpl->assign('image_url', XOOPS_URL . '/assets/images/logo.gif');
+	$dimention = getimagesize(XOOPS_ROOT_PATH . '/assets/images/logo.gif');
+	if (empty($dimention[0])) {
+		$width = 88;
+	} else {
+		$width = ($dimention[0] > 144) ? 144 : $dimention[0];
+	}
+	if (empty($dimention[1])) {
+		$height = 31;
+	} else {
+		$height = ($dimention[1] > 400) ? 400 : $dimention[1];
+	}
+	$tpl->assign('image_width', $width);
+	$tpl->assign('image_height', $height);
+	$start = 0;
+	$limit = references_utils::getModuleOption('nb_perpage');
+	$items = array();
 
-    $items = $h_references_articles->getRecentArticles($start, $limit);
-    foreach ($items as $item) {
-        $titre       = htmlspecialchars($item->getVar('article_title', 'n'), ENT_QUOTES);
-        $description = htmlspecialchars($item->getVar('article_text'), ENT_QUOTES);
-        $link        = REFERENCES_URL;
-        $tpl->append('items', array(
-            'title'       => xoops_utf8_encode($titre),
-            'link'        => $link,
-            'guid'        => $link,
-            'pubdate'     => formatTimestamp($item->getVar('article_timestamp'), 'rss'),
-            'description' => xoops_utf8_encode($description)
-        ));
-    }
+	$items = $h_references_articles->getRecentArticles($start, $limit);
+	foreach ($items as $item) {
+		$titre       = htmlspecialchars($item->getVar('article_title', 'n'), ENT_QUOTES);
+		$description = htmlspecialchars($item->getVar('article_text'), ENT_QUOTES);
+		$link        = REFERENCES_URL;
+		$tpl->append('items', array(
+			'title'       => xoops_utf8_encode($titre),
+			'link'        => $link,
+			'guid'        => $link,
+			'pubdate'     => formatTimestamp($item->getVar('article_timestamp'), 'rss'),
+			'description' => xoops_utf8_encode($description)
+		));
+	}
 }
 $tpl->display('db:references_rss.tpl', $uid);

class/references_listFilter.php

Indentation +926 added lines, -926 removed lines

@@ -35,930 +35,930 @@
  */
 class references_listFilter
 {
-    const FILTER_DATA_TEXT    = 1;
-    const FILTER_DATA_NUMERIC = 2;
-
-    const FILTER_FIELD_TEXT          = 1;
-    const FILTER_FIELD_SELECT        = 2;
-    const FILTER_FIELD_SELECT_YES_NO = 3;
-
-    /**
-     * Préfixe des variables de sélection
-     */
-    const PREFIX = 'filter_';
-
-    /**
-     * Nom du module (utilisé pour la session)
-     */
-    const MODULE_NAME = 'references';
-
-    /**
-     * Contient toutes les variables participant au filtre (avec leur type et description)
-     *
-     * @var array
-     */
-    private $vars = array();
-
-    /**
-     * Handler des données
-     *
-     * @var reference
-     */
-    private $handler = null;
-
-    /**
-     * Nom de la zone d'opération (par exemple op=products)
-     *
-     * @var string
-     */
-    private $op = '';
-
-    /**
-     * action de l'opération en cour (par exemple op=products)
-     *
-     * @var string
-     */
-    private $operationName = '';
-
-    /**
-     * Nombre maximum d'éléments pas page
-     *
-     * @var intger
-     */
-    private $limit = 10;
-
-    /**
-     * Nom de la variable start
-     *
-     * @var string
-     */
-    private $startName = '';
-
-    /**
-     * Critère {@link Criteria} servant à choisir les données
-     *
-     * @var object
-     */
-    private $criteria = null;
-
-    /**
-     * Indique s'il y a un nouveau critère
-     *
-     * @var boolean
-     */
-    private $newFilter = false;
-
-    /**
-     * Indique si la méthode filter() a été appelée
-     *
-     * @var boolean
-     */
-    private $isInitialized = false;
-
-    /**
-     * Zone de tri pour retourner les données (dans getObjects)
-     *
-     * @var string
-     */
-    private $sortField = '';
-
-    /**
-     * Sens de tri
-     *
-     * @var string
-     */
-    private $sortOrder = '';
-
-    /**
-     * Liste de critères par défaut
-     *
-     * @var array
-     */
-    private $defaultCriterias = array();
-
-    /**
-     * L'url complète du script qui appelle
-     *
-     * @var string
-     */
-    private $baseUrl = '';
-
-    /**
-     * Indique si on conserve en session la position de départ
-     *
-     * @var boolean
-     */
-    private $keepStart = true;
-
-    /**
-     * Indique si l'autocomplétion est activée
-     *
-     * @var boolean
-     */
-    private $hasAutoComplete = false;
-
-    /**
-     * Url du dossier js dans le module
-     *
-     * @var string
-     */
-    private $jsFolderUrl = '';
-
-    /**
-     * Paramètres additionnels à ajouter aux paramètres du pager
-     * @var array
-     */
-    private $additionnalPagerParameters = array();
-
-    /**
-     * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
-     * @var array
-     */
-    private $additionnalClearButtonParameters = array();
-
-    /**
-     * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
-     * @var array
-     */
-    private $sortFields = array();
-
-    /**
-     * Initialise les paramètres avec des valeurs par défaut
-     */
-    private function setDefaultValues()
-    {
-        $this->handler                          = null;
-        $this->op                               = '';
-        $this->limit                            = 10;
-        $this->startName                        = 'start';
-        $this->operationName                    = 'op';
-        $this->sortField                        = '';
-        $this->sortOrder                        = 'asc';
-        $this->baseUrl                          = '';
-        $this->keepStart                        = true;
-        $this->hasAutoComplete                  = false;
-        $this->jsFolderUrl                      = '';
-        $this->additionnalPagerParameters       = array();
-        $this->additionnalClearButtonParameters = array();
-        $this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
-    }
-
-    /**
-     * Initialisation des données, handler et opération courante dans l'appelant
-     *
-     * @param mixed   $handler   Soit une référence au handler de données soit un tableau qui contient toutes les options (auxquel cas les autres paramètres sont inutiles)
-     * @param string  $operationName
-     * @param string  $operation Opération courante dans l'appelant
-     * @param string  $startName Nom du paramètre start
-     * @param integer $limit     Nombre maximum d'éléments par page
-     * @param string  $baseUrl   L'url complète du script appelant
-     * @param string  $sortField Zone de tri
-     * @param string  $sortOrder Sens de tri
-     * @param boolean $keepStart Indique si on conserve la position de départ
-     * @param string  $jsFolderUrl
-     * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
-     */
-    public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
-    {
-        $this->setDefaultValues();
-        if (!is_array($handler)) {
-            $this->handler       = $handler;
-            $this->op            = $operation;
-            $this->limit         = $limit;
-            $this->startName     = $startName;
-            $this->operationName = $operationName;
-            $this->sortField     = $sortField;
-            $this->sortOrder     = $sortOrder;
-            $this->baseUrl       = $baseUrl;
-            $this->keepStart     = $keepStart;
-            $this->jsFolderUrl   = $jsFolderUrl;
-        } else {
-            foreach ($handler as $key => $value) {
-                $this->$key = $value;
-            }
-        }
-    }
-
-    /**
-     * Donne à la classe le nom des champs sur lesquels on peut faire le tri
-     *
-     * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
-     * @return object
-     */
-    public function setSortFields($fields)
-    {
-        $this->sortFields = $fields;
-    }
-
-    /**
-     * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
-     *
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
-     */
-    private function getSortPlaceHolderNames()
-    {
-        return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
-    }
-
-    /**
-     * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
-     *
-     * @return string
-     */
-    public function getSortPlaceHolderHtmlCode()
-    {
-        $sortNames      = $this->getSortPlaceHolderNames();
-        $sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
-        $sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
-
-        return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
-    }
-
-    /**
-     * Permet de valoriser une option directement tout en chainant
-     *
-     * @param  string $optionName
-     * @param  mixed  $optionValue
-     * @return object
-     */
-    public function setOption($optionName, $optionValue)
-    {
-        $this->$optionName = $optionValue;
-
-        return $this;
-    }
-
-    /**
-     * Ajoute un nouveau critère par défaut à la liste des critères par défaut
-     *
-     * @param Criteria $criteria
-     */
-    public function addDefaultCriteria(Criteria $criteria)
-    {
-        $this->defaultCriterias[] = $criteria;
-    }
-
-    /**
-     * Retourne une valeur d'un tableau ou null si l'index n'existe pas
-     *
-     * @param array   $array        Le tableau à traiter
-     * @param  string $index        L'index recherché
-     * @param  mixed  $defaultValue La valeur par défaut
-     * @return mixed
-     */
-    private function getArrayValue($array, $index, $defaultValue = false)
-    {
-        if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
-            $this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
-        }
-
-        return isset($array[$index]) ? $array[$index] : $defaultValue;
-    }
-
-    /**
-     * Permet de faire l'autocomplétion d'un champ
-     *
-     * @param  string $query
-     * @param         $limit
-     * @param  string $fieldName
-     * @return string
-     */
-    public function autoComplete($query, $limit, $fieldName)
-    {
-        $return = '';
-        if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
-
-            return $return;
-        }
-        if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
-            if ($this->vars[$fieldName]['autoComplete'] == true) {
-                if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
-                    $criteria = new Criteria($fieldName, $query . '%', 'LIKE');
-                }
-                $criteria->setLimit((int)$limit);
-                $ret = $this->handler->getObjects($criteria);
-
-                if (count($ret) > 0) {
-                    foreach ($ret as $object) {
-                        $return .= $object->getVar($fieldName, 'n') . "\n";
-                    }
-                }
-            }
-        }
-
-        return $return;
-    }
-
-    /**
-     * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
-     *
-     * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
-     * @return string
-     */
-    public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
-    {
-        $return = '';
-        if (!$this->hasAutoComplete) {
-            return $return;
-        }
-        $return = '';
-        $return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
-        if (!$jqueryAlreadyLoaded) {
-            $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
-        }
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
-        $return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
-        $return .= "<script type=\"text/javascript\">\n";
-        $return .= "jQuery(function($) {\n";
-        $return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
-        $return .= "var handlerName='" . $this->handler->className . "';\n";
-
-        foreach ($this->vars as $fieldName => $parameters) {
-            if ($parameters['autoComplete'] == true) {
-                $field = self::PREFIX . $fieldName;
-                $return .= "$('#" . $field . "').autocomplete(url, {\n";
-                $return .= "extraParams: {\n";
-                $return .= "    field: '" . $fieldName . "',\n";
-                $return .= "    op: 'autocomplete',\n";
-                $return .= "    handler: handlerName\n";
-                $return .= "}\n";
-                $return .= "});\n";
-            }
-        }
-        $return .= "});\n";
-        $return .= "</script>\n";
-
-        return $return;
-    }
-
-    /**
-     * Initialisation des données du filtre
-     * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
-     *
-     * @param  string $fieldName  Le nom du champs dans la table
-     * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
-     *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
-     *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
-     *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
-     *                            [size]            Largeur d'affichage pour les textbox
-     *                            [maxLength]       Largeur maximale pour les textbox
-     *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
-     *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
-     *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
-     *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
-     *                            [operator]        Opérateur de comparaison pour le Criteria
-     *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
-     * @return object L'objet courant pour pouvoir chainer
-     */
-    public function initFilter($fieldName, $parameters)
-    {
-        // Tableau des valeurs attendues avec leur valeur par défaut
-        $indexNames = array('dataType' => self::FILTER_DATA_TEXT, 'fieldType' => self::FILTER_FIELD_TEXT, 'values' => null, 'withNull' => false, 'size' => 5, 'maxLength' => 255, 'minusOne' => false, 'data' => null, 'style' => '', 'operator' => '=', 'autoComplete' => false);
-        $data       = array();
-        foreach ($indexNames as $indexName => $defaultValue) {
-            $data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
-        }
-        $this->vars[$fieldName] = $data;
-
-        return $this;
-    }
-
-    /**
-     * Retourne le nom du tableau à utiliser pour la session
-     * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
-     *
-     * @return string
-     */
-    private function getSessionName()
-    {
-        return self::MODULE_NAME . '_' . $this->handler->table;
-    }
-
-    /**
-     * Retourne le nom de la clé à utiliser pour la conservation du start en session
-     *
-     * @return string
-     */
-    private function getStartSessionName()
-    {
-        return $this->getSessionName() . '_start';
-    }
-
-    /**
-     * Réinitialisation des données avant traitement
-     *
-     * @return void
-     */
-    private function reinitializeFieldsValue()
-    {
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
-                $fieldProperties['data'] = 0;
-            } else {
-                $fieldProperties['data'] = '';
-            }
-            $this->vars[$fieldName] = $fieldProperties;
-        }
-    }
-
-    /**
-     * Ajoute les critères par défaut au critère général
-     *
-     * @return void
-     */
-    private function addDefaultCriterias()
-    {
-        if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
-            foreach ($this->defaultCriterias as $criteria) {
-                $this->criteria->add($criteria);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Indique s'il y a des champs de tri
-     *
-     * @return boolean
-     */
-    private function areThereSortFields()
-    {
-        $return = false;
-        if (is_array($this->sortFields) && count($this->sortFields) > 0) {
-            $return = true;
-        }
-
-        return $return;
-    }
-
-    /**
-     * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
-     *
-     * @param  string $fieldName
-     * @return boolean
-     */
-    private function isInSortFieldsList($fieldName)
-    {
-        return array_key_exists($fieldName, $this->sortFields);
-    }
-
-    /**
-     * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
-     *
-     * @param  string $order
-     * @return boolean
-     */
-    private function isInSortOrderList($order)
-    {
-        return in_array($order, array('asc', 'desc'));
-    }
-
-    /**
-     * Récupère, depuis la requête d'entrée, la zone de tri à utiliser et le sens du tri et place l'information en cookie
-     * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
-     *
-     * @return void
-     */
-    private function setSortFieldsFromRequest()
-    {
-        if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
-
-            return;
-        }
-        $sortField        = $sortOrder = '';
-        $cookieName       = $this->getSessionName();
-        $orderFieldsNames = $this->getSortPlaceHolderNames();
-        if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
-            $sortField = $_REQUEST[$orderFieldsNames[0]];
-            $sortOrder = $_REQUEST[$orderFieldsNames[1]];
-        } else {
-            if (isset($_SESSION[$cookieName . '_sortField'])) {
-                $sortField = $_SESSION[$cookieName . '_sortField'];
-            }
-            if (isset($_SESSION[$cookieName . '_sortOrder'])) {
-                $sortOrder = $_SESSION[$cookieName . '_sortOrder'];
-            }
-        }
-
-        if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
-            $this->sortField = $sortField;
-            $this->sortOrder = $sortOrder;
-        }
-        if (trim($sortField) != '' && trim($sortOrder) != '') {
-            $_SESSION[$cookieName . '_sortField'] = $sortField;
-            $_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
-        }
-    }
-
-    /**
-     * Réinitialisation des données avant traitement
-     *
-     * @return void
-     */
-    private function setupFilter()
-    {
-        $this->reinitializeFieldsValue();
-        $this->newFilter     = false;
-        $this->isInitialized = true;
-        $this->criteria      = new CriteriaCompo();
-        $this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
-        $this->addDefaultCriterias();
-    }
-
-    /**
-     * RAZ des données du filtre si cela a été demandé dans la requête
-     *
-     * @return void
-     */
-    private function isSetCleanFilter()
-    {
-        if (isset($_REQUEST['cleanFilter'])) {
-            $this->setStartInSession(0);
-            unset($_SESSION[$this->getSessionName()]);
-        }
-    }
-
-    /**
-     * Retourne le critère de filtrage courant
-     *
-     * @return object
-     */
-    public function getCriteria()
-    {
-        return $this->criteria;
-    }
-
-    /**
-     * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
-     *
-     * @return object L'objet courant pour pouvoir chainer
-     */
-    public function filter()
-    {
-        $this->setupFilter();                // Réinitialisations
-        $ts = MyTextSanitizer::getInstance();
-        $this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
-        $this->isSetCleanFilter();
-
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            // On commence par récupérer toutes les valeurs
-            $formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
-            $fieldProperties['data'] = null;    // Valeur par défaut
-            if (isset($_REQUEST[$formFieldName])) {
-                if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
-                    if ((int)$_REQUEST[$formFieldName] != 0) {
-                        $fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
-                        if (!$fieldProperties['minusOne']) {
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
-                        } else {
-                            $this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
-                        }
-                        $this->newFilter = true;
-                    }
-                } else {    // Zone texte
-                    if (trim($_REQUEST[$formFieldName]) != '') {
-                        $fieldProperties['data'] = $_REQUEST[$formFieldName];
-                        if (!REFERENCES_EXACT_SEARCH) {
-                            $this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
-                        } else {
-                            $this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
-                        }
-                        $this->newFilter = true;
-                    }
-                }
-            }
-            $this->vars[$fieldName] = $fieldProperties;
-        }
-
-        if ($this->newFilter) {
-            $this->setStartInSession(0);
-        }
-
-        // Récupération des donées de la session s'il n'y a pas eu de filtre(s)
-        if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
-            $sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
-            if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
-                $this->criteria = $sessionFilterData['criteria'];
-                unset($sessionFilterData['criteria']);
-            }
-            foreach ($this->vars as $fieldName => $fieldProperties) {
-                if (isset($sessionFilterData[$fieldName])) {
-                    $fieldProperties['data'] = $sessionFilterData[$fieldName];
-                }
-                $this->vars[$fieldName] = $fieldProperties;
-            }
-            unset($_SESSION[$this->getSessionName()]);
-        }
-
-        // Mise en place des données dans la session
-        $dataForSession             = array();
-        $dataForSession['criteria'] = $this->criteria;
-        foreach ($this->vars as $fieldName => $fieldProperties) {
-            $dataForSession[$fieldName] = $fieldProperties['data'];
-        }
-        $_SESSION[$this->getSessionName()] = serialize($dataForSession);
-
-        return $this;
-    }
-
-    /**
-     * Retourne le nombre d'enregistrement en fonction des critères courants
-     *
-     * @return integer
-     */
-    public function getCount()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-
-        return $this->handler->getCount($this->criteria);
-    }
-
-    /**
-     * Conserve la valeur de start en session
-     *
-     * @param  integer $start
-     * @return void
-     */
-    private function setStartInSession($start)
-    {
-        if ($this->keepStart) {
-            $startSessionName            = $this->getStartSessionName();
-            $_SESSION[$startSessionName] = (int)$start;
-        }
-    }
-
-    /**
-     * Retourne la valeur de ?start=x
-     *
-     * @return integer
-     */
-    private function getStartValue()
-    {
-        $start = 0;
-        if (isset($_REQUEST[$this->startName])) {
-            $start = (int)$_REQUEST[$this->startName];
-        } elseif ($this->keepStart) {
-            $startSessionName = $this->getStartSessionName();
-            if (isset($_SESSION[$startSessionName])) {
-                $start = (int)$_SESSION[$startSessionName];
-            }
-        }
-        // Mise en session
-        $this->setStartInSession($start);
-
-        return $start;
-    }
-
-    /**
-     * Permet d'ajouter un paramètre supplémentaire au pager
-     *
-     * @param  string $key
-     * @param  string $value
-     * @return object
-     */
-    public function addAdditionnalParameterToPager($key, $value = '')
-    {
-        $this->additionnalPagerParameters[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
-     *
-     * @param  string $key
-     * @param  string $value
-     * @return object
-     */
-    public function addAdditionnalParameterToClearButton($key, $value = '')
-    {
-        $this->additionnalClearButtonParameters[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Permet d'ajouter des paramètres supplémentaires au pager
-     *
-     * @param $array
-     * @return object
-     * @internal param string $key
-     * @internal param string $value
-     */
-    public function addAditionnalArrayParametersToPager($array)
-    {
-        if (count($array) > 0) {
-            foreach ($array as $key => $value) {
-                $this->addAdditionnalParameterToPager($key, $value);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Retourne le pager à utiliser
-     *
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
-     */
-    public function getPager()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
-        $itemsCount  = $this->getCount();
-        $queryString = array();
-        if (trim($this->op) != '') {
-            $queryString[$this->operationName] = $this->op;
-        }
-        $pagenav = null;
-
-        if ($itemsCount > $this->limit) {
-            foreach ($this->vars as $fieldName => $fieldProperties) {
-                $formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
-                $queryString[$formFieldName] = $fieldProperties['data'];
-            }
-            // Ajout des paramètres supplémentaires éventuels
-            if (count($this->additionnalPagerParameters) > 0) {
-                foreach ($this->additionnalPagerParameters as $key => $value) {
-                    $queryString[$key] = $value;
-                }
-            }
-            $start   = $this->getStartValue();
-            $pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
-        }
-
-        return $pagenav;
-    }
-
-    /**
-     * Retourne une liste d'objets en fonction des critères définis
-     *
-     * @return array
-     */
-    public function getObjects()
-    {
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        $start    = $this->getStartValue();
-        $limit    = $this->limit;
-        $criteria = $this->criteria;
-        $criteria->setStart($start);
-        $criteria->setLimit($limit);
-
-        $criteria->setOrder($this->sortOrder);
-        if (trim($this->sortField) != '') {
-            $criteria->setSort($this->sortField);
-        } elseif (trim($this->handler->identifierName) != '') {
-            $criteria->setSort($this->handler->identifierName);
-        }
-
-        return $this->handler->getObjects($this->criteria);
-    }
-
-    /**
-     * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
-     *
-     * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
-     * @return string
-     */
-    public function getFilterField($fieldName)
-    {
-        $html = '';
-        if (!$this->isInitialized) {
-            $this->filter();
-        }
-        if (!isset($this->vars[$fieldName])) {
-            trigger_error('Error, unknow field');
-
-            return $html;
-        }
-        $fieldData     = $this->vars[$fieldName];
-        $htmlFieldName = self::PREFIX . $fieldName;
-
-        switch ($fieldData['fieldType']) {
-            case self::FILTER_FIELD_TEXT:    // Zone de texte
-                $ts   = MyTextSanitizer::getInstance();
-                $html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
-                break;
-
-            case self::FILTER_FIELD_SELECT;     // Select
-                $style = '';
-                if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
-                    $style = $fieldData['style'];
-                }
-                $html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
-                break;
-
-            case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
-                $html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
-                break;
-        }
-
-        return $html;
-    }
-
-    /**
-     * Assigne toutes les zones de filtre à un template
-     *
-     * @param  object  $xoopsTpl
-     * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
-     * @param string   $arrayName Le nom du tableau à utiliser
-     * @return void
-     */
-    public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
-    {
-        $fields = array_keys($this->vars);
-        foreach ($fields as $field) {
-            if (!$asArray) {
-                $xoopsTpl->assign($field, $this->getFilterField($field));
-            } else {
-                $xoopsTpl->append($arrayName, $this->getFilterField($field));
-            }
-        }
-    }
-
-    /**
-     * Retourne le bouton utilisé pour supprimer le filtre en cours
-     *
-     * @return string
-     */
-    public function getClearFilterbutton()
-    {
-        $queryString                       = array();
-        $queryString[$this->operationName] = $this->op;
-        if (count($this->additionnalClearButtonParameters) > 0) {
-            foreach ($this->additionnalClearButtonParameters as $key => $value) {
-                $queryString[$key] = $value;
-            }
-        }
-        $queryString['cleanFilter'] = '1';
-        $baseurl                    = $this->baseUrl;
-
-        return "&nbsp;&nbsp;<a href='$baseurl?" . http_build_query($queryString) . "' title='" . _MD_REFERENCES_CLEAN_FILTER . "'><img align='top' src='../assets/images/clear_left.png' alt='" . _MD_REFERENCES_CLEAN_FILTER . "' /></a>";
-    }
-
-    /**
-     * Retourne le bouton permettant de lancer le filtrage
-     *
-     * @param string $description  Texte à faire apparaître sur le bouton
-     * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
-     * @return string
-     */
-    public function getGoButton($description = _GO, $additionnals = null)
-    {
-        $html = '';
-        if (trim($this->operationName) != '' && trim($this->op) != '') {
-            $html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
-        }
-        if (!is_null($additionnals)) {
-            foreach ($additionnals as $key => $value) {
-                $html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
-            }
-        }
-        $html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
-
-        return $html;
-    }
-
-    /**
-     * Retourne le nom de la zone utilisée pour trier les données
-     *
-     * @return string
-     */
-    public function getSortField()
-    {
-        return $this->sortField;
-    }
-
-    /**
-     * Retourne le sens de tri utilisé pour trier les données
-     *
-     * @return string
-     */
-    public function getSortOrder()
-    {
-        return $this->sortOrder();
-    }
-
-    /**
-     * Retourne la valeur d'un champ
-     *
-     * @param  string $fieldName
-     * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
-     */
-    public function getFieldValue($fieldName)
-    {
-        $ret = null;
-        if (isset($this->vars[$fieldName])) {
-            $ret = $this->vars[$fieldName]['data'];
-        }
-
-        return $ret;
-    }
+	const FILTER_DATA_TEXT    = 1;
+	const FILTER_DATA_NUMERIC = 2;
+
+	const FILTER_FIELD_TEXT          = 1;
+	const FILTER_FIELD_SELECT        = 2;
+	const FILTER_FIELD_SELECT_YES_NO = 3;
+
+	/**
+	 * Préfixe des variables de sélection
+	 */
+	const PREFIX = 'filter_';
+
+	/**
+	 * Nom du module (utilisé pour la session)
+	 */
+	const MODULE_NAME = 'references';
+
+	/**
+	 * Contient toutes les variables participant au filtre (avec leur type et description)
+	 *
+	 * @var array
+	 */
+	private $vars = array();
+
+	/**
+	 * Handler des données
+	 *
+	 * @var reference
+	 */
+	private $handler = null;
+
+	/**
+	 * Nom de la zone d'opération (par exemple op=products)
+	 *
+	 * @var string
+	 */
+	private $op = '';
+
+	/**
+	 * action de l'opération en cour (par exemple op=products)
+	 *
+	 * @var string
+	 */
+	private $operationName = '';
+
+	/**
+	 * Nombre maximum d'éléments pas page
+	 *
+	 * @var intger
+	 */
+	private $limit = 10;
+
+	/**
+	 * Nom de la variable start
+	 *
+	 * @var string
+	 */
+	private $startName = '';
+
+	/**
+	 * Critère {@link Criteria} servant à choisir les données
+	 *
+	 * @var object
+	 */
+	private $criteria = null;
+
+	/**
+	 * Indique s'il y a un nouveau critère
+	 *
+	 * @var boolean
+	 */
+	private $newFilter = false;
+
+	/**
+	 * Indique si la méthode filter() a été appelée
+	 *
+	 * @var boolean
+	 */
+	private $isInitialized = false;
+
+	/**
+	 * Zone de tri pour retourner les données (dans getObjects)
+	 *
+	 * @var string
+	 */
+	private $sortField = '';
+
+	/**
+	 * Sens de tri
+	 *
+	 * @var string
+	 */
+	private $sortOrder = '';
+
+	/**
+	 * Liste de critères par défaut
+	 *
+	 * @var array
+	 */
+	private $defaultCriterias = array();
+
+	/**
+	 * L'url complète du script qui appelle
+	 *
+	 * @var string
+	 */
+	private $baseUrl = '';
+
+	/**
+	 * Indique si on conserve en session la position de départ
+	 *
+	 * @var boolean
+	 */
+	private $keepStart = true;
+
+	/**
+	 * Indique si l'autocomplétion est activée
+	 *
+	 * @var boolean
+	 */
+	private $hasAutoComplete = false;
+
+	/**
+	 * Url du dossier js dans le module
+	 *
+	 * @var string
+	 */
+	private $jsFolderUrl = '';
+
+	/**
+	 * Paramètres additionnels à ajouter aux paramètres du pager
+	 * @var array
+	 */
+	private $additionnalPagerParameters = array();
+
+	/**
+	 * Paramètres additionnels à ajouter au bouton permettant de supprimer le filtre en cours
+	 * @var array
+	 */
+	private $additionnalClearButtonParameters = array();
+
+	/**
+	 * Tableau des champs triables [clé] = nom du champ dans la base, valeur = libellé
+	 * @var array
+	 */
+	private $sortFields = array();
+
+	/**
+	 * Initialise les paramètres avec des valeurs par défaut
+	 */
+	private function setDefaultValues()
+	{
+		$this->handler                          = null;
+		$this->op                               = '';
+		$this->limit                            = 10;
+		$this->startName                        = 'start';
+		$this->operationName                    = 'op';
+		$this->sortField                        = '';
+		$this->sortOrder                        = 'asc';
+		$this->baseUrl                          = '';
+		$this->keepStart                        = true;
+		$this->hasAutoComplete                  = false;
+		$this->jsFolderUrl                      = '';
+		$this->additionnalPagerParameters       = array();
+		$this->additionnalClearButtonParameters = array();
+		$this->sortFields                       = array();    // Les champs qui peuvent être utilisés pour trier
+	}
+
+	/**
+	 * Initialisation des données, handler et opération courante dans l'appelant
+	 *
+	 * @param mixed   $handler   Soit une référence au handler de données soit un tableau qui contient toutes les options (auxquel cas les autres paramètres sont inutiles)
+	 * @param string  $operationName
+	 * @param string  $operation Opération courante dans l'appelant
+	 * @param string  $startName Nom du paramètre start
+	 * @param integer $limit     Nombre maximum d'éléments par page
+	 * @param string  $baseUrl   L'url complète du script appelant
+	 * @param string  $sortField Zone de tri
+	 * @param string  $sortOrder Sens de tri
+	 * @param boolean $keepStart Indique si on conserve la position de départ
+	 * @param string  $jsFolderUrl
+	 * @package string $jsFolderUrl Url du répertoire qui contient les scripts Javascript
+	 */
+	public function __construct($handler, $operationName = 'op', $operation = '', $startName = 'start', $limit = 10, $baseUrl = '', $sortField = '', $sortOrder = 'asc', $keepStart = true, $jsFolderUrl = '')
+	{
+		$this->setDefaultValues();
+		if (!is_array($handler)) {
+			$this->handler       = $handler;
+			$this->op            = $operation;
+			$this->limit         = $limit;
+			$this->startName     = $startName;
+			$this->operationName = $operationName;
+			$this->sortField     = $sortField;
+			$this->sortOrder     = $sortOrder;
+			$this->baseUrl       = $baseUrl;
+			$this->keepStart     = $keepStart;
+			$this->jsFolderUrl   = $jsFolderUrl;
+		} else {
+			foreach ($handler as $key => $value) {
+				$this->$key = $value;
+			}
+		}
+	}
+
+	/**
+	 * Donne à la classe le nom des champs sur lesquels on peut faire le tri
+	 *
+	 * @param  array $fields [clé] = nom du champ dans la base, valeur = libellé
+	 * @return object
+	 */
+	public function setSortFields($fields)
+	{
+		$this->sortFields = $fields;
+	}
+
+	/**
+	 * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
+	 *
+	 * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
+	 */
+	private function getSortPlaceHolderNames()
+	{
+		return array(self::PREFIX . 'sortFields', self::PREFIX . 'sortOrder');
+	}
+
+	/**
+	 * Retourne 2 sélecteurs html pour choisir la zone de tri et le sens du tri
+	 *
+	 * @return string
+	 */
+	public function getSortPlaceHolderHtmlCode()
+	{
+		$sortNames      = $this->getSortPlaceHolderNames();
+		$sortFieldsHtml = references_utils::htmlSelect($sortNames[0], $this->sortFields, $this->sortField, false);
+		$sortOrderHtml  = references_utils::htmlSelect($sortNames[1], array('asc' => _MD_REFERENCES_ASC, 'desc' => _MD_REFERENCES_DESC), $this->sortOrder, false);
+
+		return _MD_REFERENCES_SORT_BY . ' ' . $sortFieldsHtml . ' ' . $sortOrderHtml;
+	}
+
+	/**
+	 * Permet de valoriser une option directement tout en chainant
+	 *
+	 * @param  string $optionName
+	 * @param  mixed  $optionValue
+	 * @return object
+	 */
+	public function setOption($optionName, $optionValue)
+	{
+		$this->$optionName = $optionValue;
+
+		return $this;
+	}
+
+	/**
+	 * Ajoute un nouveau critère par défaut à la liste des critères par défaut
+	 *
+	 * @param Criteria $criteria
+	 */
+	public function addDefaultCriteria(Criteria $criteria)
+	{
+		$this->defaultCriterias[] = $criteria;
+	}
+
+	/**
+	 * Retourne une valeur d'un tableau ou null si l'index n'existe pas
+	 *
+	 * @param array   $array        Le tableau à traiter
+	 * @param  string $index        L'index recherché
+	 * @param  mixed  $defaultValue La valeur par défaut
+	 * @return mixed
+	 */
+	private function getArrayValue($array, $index, $defaultValue = false)
+	{
+		if ($index === 'autoComplete' && isset($array[$index]) && isset($array[$index]) == true) {
+			$this->hasAutoComplete = true;    // On en profite pour vérifier si un champ utilise l'autocomplétion
+		}
+
+		return isset($array[$index]) ? $array[$index] : $defaultValue;
+	}
+
+	/**
+	 * Permet de faire l'autocomplétion d'un champ
+	 *
+	 * @param  string $query
+	 * @param         $limit
+	 * @param  string $fieldName
+	 * @return string
+	 */
+	public function autoComplete($query, $limit, $fieldName)
+	{
+		$return = '';
+		if (!$this->hasAutoComplete) {    // Si aucun champ n'est en autocomplétion, c'est pas la peine d'aller plus loin
+
+			return $return;
+		}
+		if (isset($this->vars[$fieldName])) {    // On vérifie que le champ demandé est bien en autocomplétion
+			if ($this->vars[$fieldName]['autoComplete'] == true) {
+				if ($this->vars[$fieldName]['dataType'] == self::FILTER_DATA_TEXT) {
+					$criteria = new Criteria($fieldName, $query . '%', 'LIKE');
+				}
+				$criteria->setLimit((int)$limit);
+				$ret = $this->handler->getObjects($criteria);
+
+				if (count($ret) > 0) {
+					foreach ($ret as $object) {
+						$return .= $object->getVar($fieldName, 'n') . "\n";
+					}
+				}
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Retourne le code Javascript à utiliser pour initialiser l'auto complétion (et donc à coller dans le code html)
+	 *
+	 * @param boolean $jqueryAlreadyLoaded Indique si jQuery est déjà chargé par l'appelant, auquel cas rien ne sert de le recharger
+	 * @return string
+	 */
+	public function getJavascriptInitCode($jqueryAlreadyLoaded = false)
+	{
+		$return = '';
+		if (!$this->hasAutoComplete) {
+			return $return;
+		}
+		$return = '';
+		$return .= "<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" title=\"Style sheet\" href=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.css\" />\n";
+		if (!$jqueryAlreadyLoaded) {
+			$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "jquery/jquery.js\"></script>\n";
+		}
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "noconflict.js\"></script>\n";
+		$return .= "<script type=\"text/javascript\" src=\"" . $this->jsFolderUrl . "autocomplete/jquery.autocomplete.min.js\"></script>\n";
+		$return .= "<script type=\"text/javascript\">\n";
+		$return .= "jQuery(function($) {\n";
+		$return .= "var url='" . $this->baseUrl . "';\n";    // TODO: Supprimer "var" car cela limite sa portée !
+		$return .= "var handlerName='" . $this->handler->className . "';\n";
+
+		foreach ($this->vars as $fieldName => $parameters) {
+			if ($parameters['autoComplete'] == true) {
+				$field = self::PREFIX . $fieldName;
+				$return .= "$('#" . $field . "').autocomplete(url, {\n";
+				$return .= "extraParams: {\n";
+				$return .= "    field: '" . $fieldName . "',\n";
+				$return .= "    op: 'autocomplete',\n";
+				$return .= "    handler: handlerName\n";
+				$return .= "}\n";
+				$return .= "});\n";
+			}
+		}
+		$return .= "});\n";
+		$return .= "</script>\n";
+
+		return $return;
+	}
+
+	/**
+	 * Initialisation des données du filtre
+	 * Permet d'indiquer quelles sont les zones sur lesquelles on effectue des filtres ainsi que leur type
+	 *
+	 * @param  string $fieldName  Le nom du champs dans la table
+	 * @param  array  $parameters Les paramètres de la zone sous la forme d'un tableau :
+	 *                            [dataType]        Entier représentant le type de donnée (numérique ou chaine)
+	 *                            [fieldType]       Le type de zone de saisie (zone de texte, liste déroulante, liste déroulante Oui/Non)
+	 *                            [values]      La ou les valeurs de la zone de saisie (utilisé dans le cas d'un select)
+	 *                            [size]            Largeur d'affichage pour les textbox
+	 *                            [maxLength]       Largeur maximale pour les textbox
+	 *                            [withNull]        Dans le cas des listes déroulantes, indique s'il faut une valeur nulle
+	 *                            [minusOne]        Indique s'il faut retrancher 1 à la valeur saisie récupérée (cas classique des listes Oui/Non avec une valeur nulle)
+	 *                            [style]            Dans le cas des liste déroulante, le style à appliquer à la liste
+	 *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
+	 *                            [operator]        Opérateur de comparaison pour le Criteria
+	 *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
+	 * @return object L'objet courant pour pouvoir chainer
+	 */
+	public function initFilter($fieldName, $parameters)
+	{
+		// Tableau des valeurs attendues avec leur valeur par défaut
+		$indexNames = array('dataType' => self::FILTER_DATA_TEXT, 'fieldType' => self::FILTER_FIELD_TEXT, 'values' => null, 'withNull' => false, 'size' => 5, 'maxLength' => 255, 'minusOne' => false, 'data' => null, 'style' => '', 'operator' => '=', 'autoComplete' => false);
+		$data       = array();
+		foreach ($indexNames as $indexName => $defaultValue) {
+			$data[$indexName] = $this->getArrayValue($parameters, $indexName, $defaultValue);
+		}
+		$this->vars[$fieldName] = $data;
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le nom du tableau à utiliser pour la session
+	 * @note : Le nom de la session est composé de : nom du module_nom du handler, par exemple references_references_articles
+	 *
+	 * @return string
+	 */
+	private function getSessionName()
+	{
+		return self::MODULE_NAME . '_' . $this->handler->table;
+	}
+
+	/**
+	 * Retourne le nom de la clé à utiliser pour la conservation du start en session
+	 *
+	 * @return string
+	 */
+	private function getStartSessionName()
+	{
+		return $this->getSessionName() . '_start';
+	}
+
+	/**
+	 * Réinitialisation des données avant traitement
+	 *
+	 * @return void
+	 */
+	private function reinitializeFieldsValue()
+	{
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
+				$fieldProperties['data'] = 0;
+			} else {
+				$fieldProperties['data'] = '';
+			}
+			$this->vars[$fieldName] = $fieldProperties;
+		}
+	}
+
+	/**
+	 * Ajoute les critères par défaut au critère général
+	 *
+	 * @return void
+	 */
+	private function addDefaultCriterias()
+	{
+		if (is_array($this->defaultCriterias) && count($this->defaultCriterias) > 0) {
+			foreach ($this->defaultCriterias as $criteria) {
+				$this->criteria->add($criteria);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Indique s'il y a des champs de tri
+	 *
+	 * @return boolean
+	 */
+	private function areThereSortFields()
+	{
+		$return = false;
+		if (is_array($this->sortFields) && count($this->sortFields) > 0) {
+			$return = true;
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Indique si le nom du champ passé en paramètre fait partie de la liste des champs "triables"
+	 *
+	 * @param  string $fieldName
+	 * @return boolean
+	 */
+	private function isInSortFieldsList($fieldName)
+	{
+		return array_key_exists($fieldName, $this->sortFields);
+	}
+
+	/**
+	 * Indique si le sens de tri passé en paramètre fait partie de la liste autorisée
+	 *
+	 * @param  string $order
+	 * @return boolean
+	 */
+	private function isInSortOrderList($order)
+	{
+		return in_array($order, array('asc', 'desc'));
+	}
+
+	/**
+	 * Récupère, depuis la requête d'entrée, la zone de tri à utiliser et le sens du tri et place l'information en cookie
+	 * pour que lorsque l'utilisateur se reconnecte, il retrouve ses informations de tri
+	 *
+	 * @return void
+	 */
+	private function setSortFieldsFromRequest()
+	{
+		if (!$this->areThereSortFields()) {    // S'il n'y a pas de champs triables, on laisse tomber
+
+			return;
+		}
+		$sortField        = $sortOrder = '';
+		$cookieName       = $this->getSessionName();
+		$orderFieldsNames = $this->getSortPlaceHolderNames();
+		if (isset($_REQUEST[$orderFieldsNames[0]]) && isset($_REQUEST[$orderFieldsNames[1]])) {
+			$sortField = $_REQUEST[$orderFieldsNames[0]];
+			$sortOrder = $_REQUEST[$orderFieldsNames[1]];
+		} else {
+			if (isset($_SESSION[$cookieName . '_sortField'])) {
+				$sortField = $_SESSION[$cookieName . '_sortField'];
+			}
+			if (isset($_SESSION[$cookieName . '_sortOrder'])) {
+				$sortOrder = $_SESSION[$cookieName . '_sortOrder'];
+			}
+		}
+
+		if ($this->isInSortFieldsList($sortField) && $this->isInSortOrderList($sortOrder)) {
+			$this->sortField = $sortField;
+			$this->sortOrder = $sortOrder;
+		}
+		if (trim($sortField) != '' && trim($sortOrder) != '') {
+			$_SESSION[$cookieName . '_sortField'] = $sortField;
+			$_SESSION[$cookieName . '_sortOrder'] = $sortOrder;
+		}
+	}
+
+	/**
+	 * Réinitialisation des données avant traitement
+	 *
+	 * @return void
+	 */
+	private function setupFilter()
+	{
+		$this->reinitializeFieldsValue();
+		$this->newFilter     = false;
+		$this->isInitialized = true;
+		$this->criteria      = new CriteriaCompo();
+		$this->criteria->add(new Criteria($this->handler->keyName, 0, '<>'));
+		$this->addDefaultCriterias();
+	}
+
+	/**
+	 * RAZ des données du filtre si cela a été demandé dans la requête
+	 *
+	 * @return void
+	 */
+	private function isSetCleanFilter()
+	{
+		if (isset($_REQUEST['cleanFilter'])) {
+			$this->setStartInSession(0);
+			unset($_SESSION[$this->getSessionName()]);
+		}
+	}
+
+	/**
+	 * Retourne le critère de filtrage courant
+	 *
+	 * @return object
+	 */
+	public function getCriteria()
+	{
+		return $this->criteria;
+	}
+
+	/**
+	 * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
+	 *
+	 * @return object L'objet courant pour pouvoir chainer
+	 */
+	public function filter()
+	{
+		$this->setupFilter();                // Réinitialisations
+		$ts = MyTextSanitizer::getInstance();
+		$this->setSortFieldsFromRequest();    // On récupère la zone de tri éventuellement passée dans la requête
+		$this->isSetCleanFilter();
+
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			// On commence par récupérer toutes les valeurs
+			$formFieldName           = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
+			$fieldProperties['data'] = null;    // Valeur par défaut
+			if (isset($_REQUEST[$formFieldName])) {
+				if ($fieldProperties['dataType'] == self::FILTER_DATA_NUMERIC) {    // Zone numérique
+					if ((int)$_REQUEST[$formFieldName] != 0) {
+						$fieldProperties['data'] = (int)$_REQUEST[$formFieldName];
+						if (!$fieldProperties['minusOne']) {
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'], $fieldProperties['operator']));
+						} else {
+							$this->criteria->add(new Criteria($fieldName, $fieldProperties['data'] - 1, $fieldProperties['operator']));
+						}
+						$this->newFilter = true;
+					}
+				} else {    // Zone texte
+					if (trim($_REQUEST[$formFieldName]) != '') {
+						$fieldProperties['data'] = $_REQUEST[$formFieldName];
+						if (!REFERENCES_EXACT_SEARCH) {
+							$this->criteria->add(new Criteria($fieldName, '%' . $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+						} else {
+							$this->criteria->add(new Criteria($fieldName, $ts->addSlashes($fieldProperties['data']) . '%', 'LIKE'));
+						}
+						$this->newFilter = true;
+					}
+				}
+			}
+			$this->vars[$fieldName] = $fieldProperties;
+		}
+
+		if ($this->newFilter) {
+			$this->setStartInSession(0);
+		}
+
+		// Récupération des donées de la session s'il n'y a pas eu de filtre(s)
+		if (!$this->newFilter && isset($_SESSION[$this->getSessionName()])) {
+			$sessionFilterData = unserialize($_SESSION[$this->getSessionName()]);
+			if (isset($sessionFilterData['criteria']) && is_object($sessionFilterData['criteria'])) {
+				$this->criteria = $sessionFilterData['criteria'];
+				unset($sessionFilterData['criteria']);
+			}
+			foreach ($this->vars as $fieldName => $fieldProperties) {
+				if (isset($sessionFilterData[$fieldName])) {
+					$fieldProperties['data'] = $sessionFilterData[$fieldName];
+				}
+				$this->vars[$fieldName] = $fieldProperties;
+			}
+			unset($_SESSION[$this->getSessionName()]);
+		}
+
+		// Mise en place des données dans la session
+		$dataForSession             = array();
+		$dataForSession['criteria'] = $this->criteria;
+		foreach ($this->vars as $fieldName => $fieldProperties) {
+			$dataForSession[$fieldName] = $fieldProperties['data'];
+		}
+		$_SESSION[$this->getSessionName()] = serialize($dataForSession);
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le nombre d'enregistrement en fonction des critères courants
+	 *
+	 * @return integer
+	 */
+	public function getCount()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+
+		return $this->handler->getCount($this->criteria);
+	}
+
+	/**
+	 * Conserve la valeur de start en session
+	 *
+	 * @param  integer $start
+	 * @return void
+	 */
+	private function setStartInSession($start)
+	{
+		if ($this->keepStart) {
+			$startSessionName            = $this->getStartSessionName();
+			$_SESSION[$startSessionName] = (int)$start;
+		}
+	}
+
+	/**
+	 * Retourne la valeur de ?start=x
+	 *
+	 * @return integer
+	 */
+	private function getStartValue()
+	{
+		$start = 0;
+		if (isset($_REQUEST[$this->startName])) {
+			$start = (int)$_REQUEST[$this->startName];
+		} elseif ($this->keepStart) {
+			$startSessionName = $this->getStartSessionName();
+			if (isset($_SESSION[$startSessionName])) {
+				$start = (int)$_SESSION[$startSessionName];
+			}
+		}
+		// Mise en session
+		$this->setStartInSession($start);
+
+		return $start;
+	}
+
+	/**
+	 * Permet d'ajouter un paramètre supplémentaire au pager
+	 *
+	 * @param  string $key
+	 * @param  string $value
+	 * @return object
+	 */
+	public function addAdditionnalParameterToPager($key, $value = '')
+	{
+		$this->additionnalPagerParameters[$key] = $value;
+
+		return $this;
+	}
+
+	/**
+	 * Permet d'ajouter un paramètre supplémentaire au bouton permettant de supprimer le filtre
+	 *
+	 * @param  string $key
+	 * @param  string $value
+	 * @return object
+	 */
+	public function addAdditionnalParameterToClearButton($key, $value = '')
+	{
+		$this->additionnalClearButtonParameters[$key] = $value;
+
+		return $this;
+	}
+
+	/**
+	 * Permet d'ajouter des paramètres supplémentaires au pager
+	 *
+	 * @param $array
+	 * @return object
+	 * @internal param string $key
+	 * @internal param string $value
+	 */
+	public function addAditionnalArrayParametersToPager($array)
+	{
+		if (count($array) > 0) {
+			foreach ($array as $key => $value) {
+				$this->addAdditionnalParameterToPager($key, $value);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Retourne le pager à utiliser
+	 *
+	 * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
+	 */
+	public function getPager()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		require_once XOOPS_ROOT_PATH . '/class/pagenav.php';
+		$itemsCount  = $this->getCount();
+		$queryString = array();
+		if (trim($this->op) != '') {
+			$queryString[$this->operationName] = $this->op;
+		}
+		$pagenav = null;
+
+		if ($itemsCount > $this->limit) {
+			foreach ($this->vars as $fieldName => $fieldProperties) {
+				$formFieldName               = self::PREFIX . $fieldName;    // "filter_website_id" par exemple
+				$queryString[$formFieldName] = $fieldProperties['data'];
+			}
+			// Ajout des paramètres supplémentaires éventuels
+			if (count($this->additionnalPagerParameters) > 0) {
+				foreach ($this->additionnalPagerParameters as $key => $value) {
+					$queryString[$key] = $value;
+				}
+			}
+			$start   = $this->getStartValue();
+			$pagenav = new XoopsPageNav($itemsCount, $this->limit, $start, $this->startName, http_build_query($queryString));
+		}
+
+		return $pagenav;
+	}
+
+	/**
+	 * Retourne une liste d'objets en fonction des critères définis
+	 *
+	 * @return array
+	 */
+	public function getObjects()
+	{
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		$start    = $this->getStartValue();
+		$limit    = $this->limit;
+		$criteria = $this->criteria;
+		$criteria->setStart($start);
+		$criteria->setLimit($limit);
+
+		$criteria->setOrder($this->sortOrder);
+		if (trim($this->sortField) != '') {
+			$criteria->setSort($this->sortField);
+		} elseif (trim($this->handler->identifierName) != '') {
+			$criteria->setSort($this->handler->identifierName);
+		}
+
+		return $this->handler->getObjects($this->criteria);
+	}
+
+	/**
+	 * Retourne la zone html à utiliser pour créer la zone de filtre (avec sa valeur saisie si c'est le cas)
+	 *
+	 * @param  string $fieldName La zone de saisie dont on veut récupérer le code html
+	 * @return string
+	 */
+	public function getFilterField($fieldName)
+	{
+		$html = '';
+		if (!$this->isInitialized) {
+			$this->filter();
+		}
+		if (!isset($this->vars[$fieldName])) {
+			trigger_error('Error, unknow field');
+
+			return $html;
+		}
+		$fieldData     = $this->vars[$fieldName];
+		$htmlFieldName = self::PREFIX . $fieldName;
+
+		switch ($fieldData['fieldType']) {
+			case self::FILTER_FIELD_TEXT:    // Zone de texte
+				$ts   = MyTextSanitizer::getInstance();
+				$html = "<input type='text' name='$htmlFieldName' id='$htmlFieldName' size='" . $fieldData['size'] . "' maxlength='" . $fieldData['maxLength'] . "' value='" . $ts->htmlSpecialChars($fieldData['data']) . "' />";
+				break;
+
+			case self::FILTER_FIELD_SELECT;     // Select
+				$style = '';
+				if (isset($fieldData['style']) && trim($fieldData['style']) != '') {
+					$style = $fieldData['style'];
+				}
+				$html = references_utils::htmlSelect($htmlFieldName, $fieldData['values'], $fieldData['data'], $fieldData['withNull'], $style);
+				break;
+
+			case self::FILTER_FIELD_SELECT_YES_NO:    // Select de type Oui/Non
+				$html = references_utils::htmlSelect($htmlFieldName, array(2 => _YES, 1 => NO), $fieldData['data'], $fieldData['withNull']);
+				break;
+		}
+
+		return $html;
+	}
+
+	/**
+	 * Assigne toutes les zones de filtre à un template
+	 *
+	 * @param  object  $xoopsTpl
+	 * @param  boolean $asArray   Est-ce qu'il faut placer le résultat dans un tableau ou assigner par nom de zone de filtre
+	 * @param string   $arrayName Le nom du tableau à utiliser
+	 * @return void
+	 */
+	public function assignFilterFieldsToTemplate(&$xoopsTpl, $asArray = true, $arrayName = 'filterFields')
+	{
+		$fields = array_keys($this->vars);
+		foreach ($fields as $field) {
+			if (!$asArray) {
+				$xoopsTpl->assign($field, $this->getFilterField($field));
+			} else {
+				$xoopsTpl->append($arrayName, $this->getFilterField($field));
+			}
+		}
+	}
+
+	/**
+	 * Retourne le bouton utilisé pour supprimer le filtre en cours
+	 *
+	 * @return string
+	 */
+	public function getClearFilterbutton()
+	{
+		$queryString                       = array();
+		$queryString[$this->operationName] = $this->op;
+		if (count($this->additionnalClearButtonParameters) > 0) {
+			foreach ($this->additionnalClearButtonParameters as $key => $value) {
+				$queryString[$key] = $value;
+			}
+		}
+		$queryString['cleanFilter'] = '1';
+		$baseurl                    = $this->baseUrl;
+
+		return "&nbsp;&nbsp;<a href='$baseurl?" . http_build_query($queryString) . "' title='" . _MD_REFERENCES_CLEAN_FILTER . "'><img align='top' src='../assets/images/clear_left.png' alt='" . _MD_REFERENCES_CLEAN_FILTER . "' /></a>";
+	}
+
+	/**
+	 * Retourne le bouton permettant de lancer le filtrage
+	 *
+	 * @param string $description  Texte à faire apparaître sur le bouton
+	 * @param array  $additionnals Champs supplémentaires à faire apparaître avec le bouton
+	 * @return string
+	 */
+	public function getGoButton($description = _GO, $additionnals = null)
+	{
+		$html = '';
+		if (trim($this->operationName) != '' && trim($this->op) != '') {
+			$html .= "<input type='hidden' name='" . $this->operationName . "' id='" . $this->operationName . "' value='" . $this->op . "' />";
+		}
+		if (!is_null($additionnals)) {
+			foreach ($additionnals as $key => $value) {
+				$html .= "<input type='hidden' name='" . $key . "' id='" . $key . "' value='" . $value . "' />";
+			}
+		}
+		$html .= "<input type='submit' name='btngo' id='btngo' value='$description' />";
+
+		return $html;
+	}
+
+	/**
+	 * Retourne le nom de la zone utilisée pour trier les données
+	 *
+	 * @return string
+	 */
+	public function getSortField()
+	{
+		return $this->sortField;
+	}
+
+	/**
+	 * Retourne le sens de tri utilisé pour trier les données
+	 *
+	 * @return string
+	 */
+	public function getSortOrder()
+	{
+		return $this->sortOrder();
+	}
+
+	/**
+	 * Retourne la valeur d'un champ
+	 *
+	 * @param  string $fieldName
+	 * @return mixed  La valeur du champ ou null si on ne trouve pas la zone
+	 */
+	public function getFieldValue($fieldName)
+	{
+		$ret = null;
+		if (isset($this->vars[$fieldName])) {
+			$ret = $this->vars[$fieldName]['data'];
+		}
+
+		return $ret;
+	}
 }

class/references_utils.php

Indentation +1405 added lines, -1405 removed lines

@@ -33,654 +33,654 @@ 
 use WideImage\WideImage;
 
 if (!defined('XOOPS_ROOT_PATH')) {
-    die('XOOPS root path not defined');
+	die('XOOPS root path not defined');
 }
 
 class references_utils
 {
-    // Pour la portabilité de module à module
-    const MODULE_NAME    = 'references';
-    const MODULE_DIRNAME = REFERENCES_DIRNAME;
-    const MODULE_PATH    = REFERENCES_PATH;
-    const MODULE_URL     = REFERENCES_URL;
-    const MODULE_JS_URL  = REFERENCES_JS_URL;
-
-    /**
-     * Access the only instance of this class
-     *
-     * @return object
-     *
-     * @static
-     * @staticvar   object
-     */
-    public static function &getInstance()
-    {
-        static $instance;
-        if (!isset($instance)) {
-            $instance = new references_utils();
-        }
-
-        return $instance;
-    }
-
-    /**
-     * Returns a module's option (with cache)
-     *
-     * @param  string  $option    module option's name
-     * @param  boolean $withCache Do we have to use some cache ?
-     * @return mixed   option's value
-     */
-    public static function getModuleOption($option, $withCache = true)
-    {
-        global $xoopsModuleConfig, $xoopsModule;
-        $repmodule = self::MODULE_NAME;
-        static $options = array();
-        if (is_array($options) && array_key_exists($option, $options) && $withCache) {
-            return $options[$option];
-        }
-
-        $retval = false;
-        if (isset($xoopsModuleConfig) && (is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $repmodule && $xoopsModule->getVar('isactive'))) {
-            if (isset($xoopsModuleConfig[$option])) {
-                $retval = $xoopsModuleConfig[$option];
-            }
-        } else {
-            $module_handler = xoops_getHandler('module');
-            $module         = $module_handler->getByDirname($repmodule);
-            $config_handler = xoops_getHandler('config');
-            if ($module) {
-                $moduleConfig = $config_handler->getConfigsByCat(0, $module->getVar('mid'));
-                if (isset($moduleConfig[$option])) {
-                    $retval = $moduleConfig[$option];
-                }
-            }
-        }
-        $options[$option] = $retval;
-
-        return $retval;
-    }
-
-    /**
-     * Is Xoops 2.3.x ?
-     *
-     * @return boolean need to say it ?
-     */
-    public static function isX23()
-    {
-        $x23 = false;
-        $xv  = str_replace('XOOPS ', '', XOOPS_VERSION);
-        if ((int)substr($xv, 2, 1) >= 3) {
-            $x23 = true;
-        }
-
-        return $x23;
-    }
-
-    /**
-     * Retreive an editor according to the module's option "form_options"
-     *
-     * @param  string $caption Caption to give to the editor
-     * @param  string $name    Editor's name
-     * @param  string $value   Editor's value
-     * @param  string $width   Editor's width
-     * @param  string $height  Editor's height
-     * @param string  $supplemental
-     * @return object The editor to use
-     */
-    public static function getWysiwygForm($caption, $name, $value = '', $width = '100%', $height = '400px', $supplemental = '')
-    {
-        $editor                   = false;
-        $editor_configs           = array();
-        $editor_configs['name']   = $name;
-        $editor_configs['value']  = $value;
-        $editor_configs['rows']   = 35;
-        $editor_configs['cols']   = 60;
-        $editor_configs['width']  = '100%';
-        $editor_configs['height'] = '400px';
-
-        $editor_option = strtolower(self::getModuleOption('form_options'));
-
-        if (self::isX23()) {
-            $editor = new XoopsFormEditor($caption, $editor_option, $editor_configs);
-
-            return $editor;
-        }
-
-        // Only for Xoops 2.0.x
-        switch ($editor_option) {
-            case 'fckeditor':
-                if (is_readable(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php')) {
-                    require_once(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php');
-                    $editor = new XoopsFormFckeditor($caption, $name, $value);
-                }
-                break;
-
-            case 'htmlarea':
-                if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
-                    require_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
-                    $editor = new XoopsFormHtmlarea($caption, $name, $value);
-                }
-                break;
-
-            case 'dhtmltextarea':
-                $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 10, 50, $supplemental);
-                break;
-
-            case 'textarea':
-                $editor = new XoopsFormTextArea($caption, $name, $value);
-                break;
-
-            case 'tinyeditor':
-            case 'tinymce':
-                if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
-                    require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
-                    $editor = new XoopsFormTinyeditorTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '400px'));
-                }
-                break;
-
-            case 'koivi':
-                if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
-                    require_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
-                    $editor = new XoopsFormWysiwygTextArea($caption, $name, $value, $width, $height, '');
-                }
-                break;
-        }
-        if (!is_object($editor)) {
-            trigger_error('Error, impossible to get the requested text editor', E_USER_ERROR);
-        }
-
-        return $editor;
-    }
-
-    /**
-     * Create (in a link) a javascript confirmation's box
-     *
-     * @param  string  $message Message to display
-     * @param  boolean $form    Is this a confirmation for a form ?
-     * @return string  the javascript code to insert in the link (or in the form)
-     */
-    public static function javascriptLinkConfirm($message, $form = false)
-    {
-        if (!$form) {
-            return "onclick=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
-        } else {
-            return "onSubmit=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
-        }
-    }
-
-    /**
-     * Get current user IP
-     *
-     * @return string IP address (format Ipv4)
-     */
-    public static function IP()
-    {
-        $proxy_ip = '';
-        if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
-            $proxy_ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
-        } elseif (!empty($_SERVER['HTTP_X_FORWARDED'])) {
-            $proxy_ip = $_SERVER['HTTP_X_FORWARDED'];
-        } elseif (!empty($_SERVER['HTTP_FORWARDED_FOR'])) {
-            $proxy_ip = $_SERVER['HTTP_FORWARDED_FOR'];
-        } elseif (!empty($_SERVER['HTTP_FORWARDED'])) {
-            $proxy_ip = $_SERVER['HTTP_FORWARDED'];
-        } elseif (!empty($_SERVER['HTTP_VIA'])) {
-            $proxy_ip = $_SERVER['HTTP_VIA'];
-        } elseif (!empty($_SERVER['HTTP_X_COMING_FROM'])) {
-            $proxy_ip = $_SERVER['HTTP_X_COMING_FROM'];
-        } elseif (!empty($_SERVER['HTTP_COMING_FROM'])) {
-            $proxy_ip = $_SERVER['HTTP_COMING_FROM'];
-        }
-        $regs = array();
-        if (!empty($proxy_ip) && $is_ip = ereg('^([0-9]{1,3}\.){3,3}[0-9]{1,3}', $proxy_ip, $regs) && count($regs) > 0) {
-            $the_IP = $regs[0];
-        } else {
-            $the_IP = $_SERVER['REMOTE_ADDR'];
-        }
-
-        return $the_IP;
-    }
-
-    /**
-     * Set the page's title, meta description and meta keywords
-     * Datas are supposed to be sanitized
-     *
-     * @param  string $pageTitle       Page's Title
-     * @param  string $metaDescription Page's meta description
-     * @param  string $metaKeywords    Page's meta keywords
-     * @return void
-     */
-    public static function setMetas($pageTitle = '', $metaDescription = '', $metaKeywords = '')
-    {
-        global $xoTheme, $xoTheme, $xoopsTpl;
-        $xoopsTpl->assign('xoops_pagetitle', $pageTitle);
-        if (isset($xoTheme) && is_object($xoTheme)) {
-            if (!empty($metaKeywords)) {
-                $xoTheme->addMeta('meta', 'keywords', $metaKeywords);
-            }
-            if (!empty($metaDescription)) {
-                $xoTheme->addMeta('meta', 'description', $metaDescription);
-            }
-        } elseif (isset($xoopsTpl) && is_object($xoopsTpl)) {    // Compatibility for old Xoops versions
-            if (!empty($metaKeywords)) {
-                $xoopsTpl->assign('xoops_meta_keywords', $metaKeywords);
-            }
-            if (!empty($metaDescription)) {
-                $xoopsTpl->assign('xoops_meta_description', $metaDescription);
-            }
-        }
-    }
-
-    /**
-     * Send an email from a template to a list of recipients
-     *
-     * @param         $tplName
-     * @param  array  $recipients List of recipients
-     * @param  string $subject    Email's subject
-     * @param  array  $variables  Varirables to give to the template
-     * @return bool Result of the send
-     * @internal param string $tpl_name Template's name
-     */
-    public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables)
-    {
-        global $xoopsConfig;
-        require_once XOOPS_ROOT_PATH . '/class/xoopsmailer.php';
-        if (!is_array($recipients)) {
-            if (trim($recipients) == '') {
-                return false;
-            }
-        } else {
-            if (count($recipients) == 0) {
-                return false;
-            }
-        }
-        if (function_exists('xoops_getMailer')) {
-            $xoopsMailer =& xoops_getMailer();
-        } else {
-            $xoopsMailer =& getMailer();
-        }
-
-        $xoopsMailer->useMail();
-        $xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH . '/modules/' . self::MODULE_NAME . '/language/' . $xoopsConfig['language'] . '/mail_template');
-        $xoopsMailer->setTemplate($tplName);
-        $xoopsMailer->setToEmails($recipients);
-        // TODO: Change !
-        // $xoopsMailer->setFromEmail('contact@monsite.com');
-        //$xoopsMailer->setFromName('MonSite');
-        $xoopsMailer->setSubject($subject);
-        foreach ($variables as $key => $value) {
-            $xoopsMailer->assign($key, $value);
-        }
-        $res = $xoopsMailer->send();
-        unset($xoopsMailer);
-        $filename = XOOPS_UPLOAD_PATH . '/logmail_' . self::MODULE_NAME . '.php';
-        if (!file_exists($filename)) {
-            $fp = @fopen($filename, 'a');
-            if ($fp) {
-                fwrite($fp, '<?php exit(); ?>');
-                fclose($fp);
-            }
-        }
-        $fp = @fopen($filename, 'a');
-
-        if ($fp) {
-            fwrite($fp, str_repeat('-', 120) . "\n");
-            fwrite($fp, date('d/m/Y H:i:s') . "\n");
-            fwrite($fp, 'Template name : ' . $tplName . "\n");
-            fwrite($fp, 'Email subject : ' . $subject . "\n");
-            if (is_array($recipients)) {
-                fwrite($fp, 'Recipient(s) : ' . implode(',', $recipients) . "\n");
-            } else {
-                fwrite($fp, 'Recipient(s) : ' . $recipients . "\n");
-            }
-            fwrite($fp, 'Transmited variables : ' . implode(',', $variables) . "\n");
-            fclose($fp);
-        }
-
-        return $res;
-    }
-
-    /**
-     * Remove module's cache
-     */
-    public static function updateCache()
-    {
-        global $xoopsModule;
-        $folder  = $xoopsModule->getVar('dirname');
-        $tpllist = array();
-        require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
-        require_once XOOPS_ROOT_PATH . '/class/template.php';
-        $tplfile_handler = xoops_getHandler('tplfile');
-        $tpllist         = $tplfile_handler->find(null, null, null, $folder);
-        xoops_template_clear_module_cache($xoopsModule->getVar('mid'));            // Clear module's blocks cache
-
-        foreach ($tpllist as $onetemplate) {    // Remove cache for each page.
-            if ($onetemplate->getVar('tpl_type') === 'module') {
-                //  Note, I've been testing all the other methods (like the one of Smarty) and none of them run, that's why I have used this code
-                $files_del = array();
-                $files_del = glob(XOOPS_CACHE_PATH . '/*' . $onetemplate->getVar('tpl_file') . '*');
-                if (count($files_del) > 0 && is_array($files_del)) {
-                    foreach ($files_del as $one_file) {
-                        if (is_file($one_file)) {
-                            unlink($one_file);
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Redirect user with a message
-     *
-     * @param string $message message to display
-     * @param string $url     The place where to go
-     * @param        integer  timeout Time to wait before to redirect
-     */
-    public static function redirect($message = '', $url = 'index.php', $time = 2)
-    {
-        redirect_header($url, $time, $message);
-        exit();
-    }
-
-    /**
-     * Internal function used to get the handler of the current module
-     *
-     * @return object The module
-     */
-    public static function getModule()
-    {
-        static $mymodule;
-        if (!isset($mymodule)) {
-            global $xoopsModule;
-            if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == REFERENCES_DIRNAME) {
-                $mymodule =& $xoopsModule;
-            } else {
-                $hModule  = xoops_getHandler('module');
-                $mymodule = $hModule->getByDirname(REFERENCES_DIRNAME);
-            }
-        }
-
-        return $mymodule;
-    }
-
-    /**
-     * Returns the module's name (as defined by the user in the module manager) with cache
-     * @return string Module's name
-     */
-    public static function getModuleName()
-    {
-        static $moduleName;
-        if (!isset($moduleName)) {
-            $mymodule   = self::getModule();
-            $moduleName = $mymodule->getVar('name');
-        }
-
-        return $moduleName;
-    }
-
-    /**
-     * Create a title for the href tags inside html links
-     *
-     * @param  string $title Text to use
-     * @return string Formated text
-     */
-    public static function makeHrefTitle($title)
-    {
-        $s = "\"'";
-        $r = '  ';
-
-        return strtr($title, $s, $r);
-    }
-
-    /**
-     * Retourne la liste des utilisateurs appartenants � un groupe
-     *
-     * @param  int $groupId Searched group
-     * @return array Array of XoopsUsers
-     */
-    public static function getUsersFromGroup($groupId)
-    {
-        $users          = array();
-        $member_handler = xoops_getHandler('member');
-        $users          = $member_handler->getUsersByGroup($groupId, true);
-
-        return $users;
-    }
-
-    /**
-     * Retourne les ID des utilisateurs faisant partie de plusieurs groupes
-     * @param  array $groups Les ID des groupes dont on recherche les ID utilisateurs
-     * @return array Les ID utilisateurs
-     */
-    public static function getUsersIdsFromGroups($groups)
-    {
-        $usersIds       = array();
-        $member_handler = xoops_getHandler('member');
-        foreach ($groups as $groupId) {
-            $temporaryGroup = array();
-            $temporaryGroup = $member_handler->getUsersByGroup($groupId);
-            if (count($temporaryGroup) > 0) {
-                $usersIds = array_merge($usersIds, $temporaryGroup);
-            }
-        }
-
-        return array_unique($usersIds);
-    }
-
-    /**
-     * Retourne la liste des emails des utilisateurs membres d'un groupe
-     *
-     * @param $groupId
-     * @return array Emails list
-     * @internal param int $group_id Group's number
-     */
-    public static function getEmailsFromGroup($groupId)
-    {
-        $ret   = array();
-        $users = self::getUsersFromGroup($groupId);
-        foreach ($users as $user) {
-            $ret[] = $user->getVar('email');
-        }
-
-        return $ret;
-    }
-
-    /**
-     * V�rifie que l'utilisateur courant fait partie du groupe des administrateurs
-     *
-     * @return booleean Admin or not
-     */
-    public static function isAdmin()
-    {
-        global $xoopsUser, $xoopsModule;
-        if (is_object($xoopsUser)) {
-            if (in_array(XOOPS_GROUP_ADMIN, $xoopsUser->getGroups())) {
-                return true;
-            } elseif (isset($xoopsModule) && $xoopsUser->isAdmin($xoopsModule->getVar('mid'))) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Returns the current date in the Mysql format
-     *
-     * @return string Date in the Mysql format
-     */
-    public static function getCurrentSQLDate()
-    {
-        return date('Y-m-d');    // 2007-05-02
-    }
-
-    public static function getCurrentSQLDateTime()
-    {
-        return date('Y-m-d H:i:s');    // 2007-05-02
-    }
-
-    /**
-     * Convert a Mysql date to the human's format
-     *
-     * @param  string $date The date to convert
-     * @param string  $format
-     * @return string The date in a human form
-     */
-    public static function SQLDateToHuman($date, $format = 'l')
-    {
-        if ($date != '0000-00-00' && xoops_trim($date) != '') {
-            return formatTimestamp(strtotime($date), $format);
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Convert a timestamp to a Mysql date
-     *
-     * @param  integer $timestamp The timestamp to use
-     * @return string  The date in the Mysql format
-     */
-    public static function timestampToMysqlDate($timestamp)
-    {
-        return date('Y-m-d', (int)$timestamp);
-    }
-
-    /**
-     * Conversion d'un dateTime Mysql en date lisible en fran�ais
-     * @param $dateTime
-     * @return bool|string
-     */
-    public static function sqlDateTimeToFrench($dateTime)
-    {
-        return date('d/m/Y H:i:s', strtotime($dateTime));
-    }
-
-    /**
-     * Convert a timestamp to a Mysql datetime form
-     * @param  integer $timestamp The timestamp to use
-     * @return string  The date and time in the Mysql format
-     */
-    public static function timestampToMysqlDateTime($timestamp)
-    {
-        return date('Y-m-d H:i:s', $timestamp);
-    }
-
-    /**
-     * This function indicates if the current Xoops version needs to add asterisks to required fields in forms
-     *
-     * @return boolean Yes = we need to add them, false = no
-     */
-    public static function needsAsterisk()
-    {
-        if (self::isX23()) {
-            return false;
-        }
-        if (strpos(strtolower(XOOPS_VERSION), 'impresscms') !== false) {
-            return false;
-        }
-        if (strpos(strtolower(XOOPS_VERSION), 'legacy') === false) {
-            $xv = xoops_trim(str_replace('XOOPS ', '', XOOPS_VERSION));
-            if ((int)substr($xv, 4, 2) >= 17) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Mark the mandatory fields of a form with a star
-     *
-     * @param  object $sform The form to modify
-     * @return object The modified form
-     * @internal param string $caracter The character to use to mark fields
-     */
-    public static function &formMarkRequiredFields(&$sform)
-    {
-        if (self::needsAsterisk()) {
-            $required = array();
-            foreach ($sform->getRequired() as $item) {
-                $required[] = $item->_name;
-            }
-            $elements = array();
-            $elements = &$sform->getElements();
-            $cnt      = count($elements);
-            for ($i = 0; $i < $cnt; ++$i) {
-                if (is_object($elements[$i]) && in_array($elements[$i]->_name, $required)) {
-                    $elements[$i]->_caption .= ' *';
-                }
-            }
-        }
-
-        return $sform;
-    }
-
-    /**
-     * Create an html heading (from h1 to h6)
-     *
-     * @param  string  $title The text to use
-     * @param  integer $level Level to return
-     * @return string  The heading
-     */
-    public static function htitle($title = '', $level = 1)
-    {
-        printf('<h%01d>%s</h%01d>', $level, $title, $level);
-    }
-
-    /**
-     * Create a unique upload filename
-     *
-     * @param  string  $folder   The folder where the file will be saved
-     * @param  string  $fileName Original filename (coming from the user)
-     * @param  boolean $trimName Do we need to create a short unique name ?
-     * @return string  The unique filename to use (with its extension)
-     */
-    public static function createUploadName($folder, $fileName, $trimName = false)
-    {
-        $workingfolder = $folder;
-        if (substr($workingfolder, strlen($workingfolder) - 1, 1) !== '/') {
-            $workingfolder .= '/';
-        }
-        $ext  = basename($fileName);
-        $ext  = explode('.', $ext);
-        $ext  = '.' . $ext[count($ext) - 1];
-        $true = true;
-        while ($true) {
-            $ipbits = explode('.', $_SERVER['REMOTE_ADDR']);
-            list($usec, $sec) = explode(' ', microtime());
-            $usec = (integer)($usec * 65536);
-            $sec  = ((integer)$sec) & 0xFFFF;
-
-            if ($trimName) {
-                $uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
-            } else {
-                $uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
-            }
-            if (!file_exists($workingfolder . $uid . $ext)) {
-                $true = false;
-            }
-        }
-
-        return $uid . $ext;
-    }
-
-    /**
-     * Replace html entities with their ASCII equivalent
-     *
-     * @param  string $chaine The string undecode
-     * @return string The undecoded string
-     */
-    public static function unhtml($chaine)
-    {
-        $search = $replace = array();
-        $chaine = html_entity_decode($chaine);
-
-        for ($i = 0; $i <= 255; ++$i) {
-            $search[]  = '&#' . $i . ';';
-            $replace[] = chr($i);
-        }
+	// Pour la portabilité de module à module
+	const MODULE_NAME    = 'references';
+	const MODULE_DIRNAME = REFERENCES_DIRNAME;
+	const MODULE_PATH    = REFERENCES_PATH;
+	const MODULE_URL     = REFERENCES_URL;
+	const MODULE_JS_URL  = REFERENCES_JS_URL;
+
+	/**
+	 * Access the only instance of this class
+	 *
+	 * @return object
+	 *
+	 * @static
+	 * @staticvar   object
+	 */
+	public static function &getInstance()
+	{
+		static $instance;
+		if (!isset($instance)) {
+			$instance = new references_utils();
+		}
+
+		return $instance;
+	}
+
+	/**
+	 * Returns a module's option (with cache)
+	 *
+	 * @param  string  $option    module option's name
+	 * @param  boolean $withCache Do we have to use some cache ?
+	 * @return mixed   option's value
+	 */
+	public static function getModuleOption($option, $withCache = true)
+	{
+		global $xoopsModuleConfig, $xoopsModule;
+		$repmodule = self::MODULE_NAME;
+		static $options = array();
+		if (is_array($options) && array_key_exists($option, $options) && $withCache) {
+			return $options[$option];
+		}
+
+		$retval = false;
+		if (isset($xoopsModuleConfig) && (is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $repmodule && $xoopsModule->getVar('isactive'))) {
+			if (isset($xoopsModuleConfig[$option])) {
+				$retval = $xoopsModuleConfig[$option];
+			}
+		} else {
+			$module_handler = xoops_getHandler('module');
+			$module         = $module_handler->getByDirname($repmodule);
+			$config_handler = xoops_getHandler('config');
+			if ($module) {
+				$moduleConfig = $config_handler->getConfigsByCat(0, $module->getVar('mid'));
+				if (isset($moduleConfig[$option])) {
+					$retval = $moduleConfig[$option];
+				}
+			}
+		}
+		$options[$option] = $retval;
+
+		return $retval;
+	}
+
+	/**
+	 * Is Xoops 2.3.x ?
+	 *
+	 * @return boolean need to say it ?
+	 */
+	public static function isX23()
+	{
+		$x23 = false;
+		$xv  = str_replace('XOOPS ', '', XOOPS_VERSION);
+		if ((int)substr($xv, 2, 1) >= 3) {
+			$x23 = true;
+		}
+
+		return $x23;
+	}
+
+	/**
+	 * Retreive an editor according to the module's option "form_options"
+	 *
+	 * @param  string $caption Caption to give to the editor
+	 * @param  string $name    Editor's name
+	 * @param  string $value   Editor's value
+	 * @param  string $width   Editor's width
+	 * @param  string $height  Editor's height
+	 * @param string  $supplemental
+	 * @return object The editor to use
+	 */
+	public static function getWysiwygForm($caption, $name, $value = '', $width = '100%', $height = '400px', $supplemental = '')
+	{
+		$editor                   = false;
+		$editor_configs           = array();
+		$editor_configs['name']   = $name;
+		$editor_configs['value']  = $value;
+		$editor_configs['rows']   = 35;
+		$editor_configs['cols']   = 60;
+		$editor_configs['width']  = '100%';
+		$editor_configs['height'] = '400px';
+
+		$editor_option = strtolower(self::getModuleOption('form_options'));
+
+		if (self::isX23()) {
+			$editor = new XoopsFormEditor($caption, $editor_option, $editor_configs);
+
+			return $editor;
+		}
+
+		// Only for Xoops 2.0.x
+		switch ($editor_option) {
+			case 'fckeditor':
+				if (is_readable(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php')) {
+					require_once(XOOPS_ROOT_PATH . '/class/fckeditor/formfckeditor.php');
+					$editor = new XoopsFormFckeditor($caption, $name, $value);
+				}
+				break;
+
+			case 'htmlarea':
+				if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
+					require_once(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php');
+					$editor = new XoopsFormHtmlarea($caption, $name, $value);
+				}
+				break;
+
+			case 'dhtmltextarea':
+				$editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 10, 50, $supplemental);
+				break;
+
+			case 'textarea':
+				$editor = new XoopsFormTextArea($caption, $name, $value);
+				break;
+
+			case 'tinyeditor':
+			case 'tinymce':
+				if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php')) {
+					require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php';
+					$editor = new XoopsFormTinyeditorTextArea(array('caption' => $caption, 'name' => $name, 'value' => $value, 'width' => '100%', 'height' => '400px'));
+				}
+				break;
+
+			case 'koivi':
+				if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
+					require_once(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php');
+					$editor = new XoopsFormWysiwygTextArea($caption, $name, $value, $width, $height, '');
+				}
+				break;
+		}
+		if (!is_object($editor)) {
+			trigger_error('Error, impossible to get the requested text editor', E_USER_ERROR);
+		}
+
+		return $editor;
+	}
+
+	/**
+	 * Create (in a link) a javascript confirmation's box
+	 *
+	 * @param  string  $message Message to display
+	 * @param  boolean $form    Is this a confirmation for a form ?
+	 * @return string  the javascript code to insert in the link (or in the form)
+	 */
+	public static function javascriptLinkConfirm($message, $form = false)
+	{
+		if (!$form) {
+			return "onclick=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
+		} else {
+			return "onSubmit=\"javascript:return confirm('" . str_replace("'", ' ', $message) . "')\"";
+		}
+	}
+
+	/**
+	 * Get current user IP
+	 *
+	 * @return string IP address (format Ipv4)
+	 */
+	public static function IP()
+	{
+		$proxy_ip = '';
+		if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
+			$proxy_ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
+		} elseif (!empty($_SERVER['HTTP_X_FORWARDED'])) {
+			$proxy_ip = $_SERVER['HTTP_X_FORWARDED'];
+		} elseif (!empty($_SERVER['HTTP_FORWARDED_FOR'])) {
+			$proxy_ip = $_SERVER['HTTP_FORWARDED_FOR'];
+		} elseif (!empty($_SERVER['HTTP_FORWARDED'])) {
+			$proxy_ip = $_SERVER['HTTP_FORWARDED'];
+		} elseif (!empty($_SERVER['HTTP_VIA'])) {
+			$proxy_ip = $_SERVER['HTTP_VIA'];
+		} elseif (!empty($_SERVER['HTTP_X_COMING_FROM'])) {
+			$proxy_ip = $_SERVER['HTTP_X_COMING_FROM'];
+		} elseif (!empty($_SERVER['HTTP_COMING_FROM'])) {
+			$proxy_ip = $_SERVER['HTTP_COMING_FROM'];
+		}
+		$regs = array();
+		if (!empty($proxy_ip) && $is_ip = ereg('^([0-9]{1,3}\.){3,3}[0-9]{1,3}', $proxy_ip, $regs) && count($regs) > 0) {
+			$the_IP = $regs[0];
+		} else {
+			$the_IP = $_SERVER['REMOTE_ADDR'];
+		}
+
+		return $the_IP;
+	}
+
+	/**
+	 * Set the page's title, meta description and meta keywords
+	 * Datas are supposed to be sanitized
+	 *
+	 * @param  string $pageTitle       Page's Title
+	 * @param  string $metaDescription Page's meta description
+	 * @param  string $metaKeywords    Page's meta keywords
+	 * @return void
+	 */
+	public static function setMetas($pageTitle = '', $metaDescription = '', $metaKeywords = '')
+	{
+		global $xoTheme, $xoTheme, $xoopsTpl;
+		$xoopsTpl->assign('xoops_pagetitle', $pageTitle);
+		if (isset($xoTheme) && is_object($xoTheme)) {
+			if (!empty($metaKeywords)) {
+				$xoTheme->addMeta('meta', 'keywords', $metaKeywords);
+			}
+			if (!empty($metaDescription)) {
+				$xoTheme->addMeta('meta', 'description', $metaDescription);
+			}
+		} elseif (isset($xoopsTpl) && is_object($xoopsTpl)) {    // Compatibility for old Xoops versions
+			if (!empty($metaKeywords)) {
+				$xoopsTpl->assign('xoops_meta_keywords', $metaKeywords);
+			}
+			if (!empty($metaDescription)) {
+				$xoopsTpl->assign('xoops_meta_description', $metaDescription);
+			}
+		}
+	}
+
+	/**
+	 * Send an email from a template to a list of recipients
+	 *
+	 * @param         $tplName
+	 * @param  array  $recipients List of recipients
+	 * @param  string $subject    Email's subject
+	 * @param  array  $variables  Varirables to give to the template
+	 * @return bool Result of the send
+	 * @internal param string $tpl_name Template's name
+	 */
+	public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables)
+	{
+		global $xoopsConfig;
+		require_once XOOPS_ROOT_PATH . '/class/xoopsmailer.php';
+		if (!is_array($recipients)) {
+			if (trim($recipients) == '') {
+				return false;
+			}
+		} else {
+			if (count($recipients) == 0) {
+				return false;
+			}
+		}
+		if (function_exists('xoops_getMailer')) {
+			$xoopsMailer =& xoops_getMailer();
+		} else {
+			$xoopsMailer =& getMailer();
+		}
+
+		$xoopsMailer->useMail();
+		$xoopsMailer->setTemplateDir(XOOPS_ROOT_PATH . '/modules/' . self::MODULE_NAME . '/language/' . $xoopsConfig['language'] . '/mail_template');
+		$xoopsMailer->setTemplate($tplName);
+		$xoopsMailer->setToEmails($recipients);
+		// TODO: Change !
+		// $xoopsMailer->setFromEmail('contact@monsite.com');
+		//$xoopsMailer->setFromName('MonSite');
+		$xoopsMailer->setSubject($subject);
+		foreach ($variables as $key => $value) {
+			$xoopsMailer->assign($key, $value);
+		}
+		$res = $xoopsMailer->send();
+		unset($xoopsMailer);
+		$filename = XOOPS_UPLOAD_PATH . '/logmail_' . self::MODULE_NAME . '.php';
+		if (!file_exists($filename)) {
+			$fp = @fopen($filename, 'a');
+			if ($fp) {
+				fwrite($fp, '<?php exit(); ?>');
+				fclose($fp);
+			}
+		}
+		$fp = @fopen($filename, 'a');
+
+		if ($fp) {
+			fwrite($fp, str_repeat('-', 120) . "\n");
+			fwrite($fp, date('d/m/Y H:i:s') . "\n");
+			fwrite($fp, 'Template name : ' . $tplName . "\n");
+			fwrite($fp, 'Email subject : ' . $subject . "\n");
+			if (is_array($recipients)) {
+				fwrite($fp, 'Recipient(s) : ' . implode(',', $recipients) . "\n");
+			} else {
+				fwrite($fp, 'Recipient(s) : ' . $recipients . "\n");
+			}
+			fwrite($fp, 'Transmited variables : ' . implode(',', $variables) . "\n");
+			fclose($fp);
+		}
+
+		return $res;
+	}
+
+	/**
+	 * Remove module's cache
+	 */
+	public static function updateCache()
+	{
+		global $xoopsModule;
+		$folder  = $xoopsModule->getVar('dirname');
+		$tpllist = array();
+		require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
+		require_once XOOPS_ROOT_PATH . '/class/template.php';
+		$tplfile_handler = xoops_getHandler('tplfile');
+		$tpllist         = $tplfile_handler->find(null, null, null, $folder);
+		xoops_template_clear_module_cache($xoopsModule->getVar('mid'));            // Clear module's blocks cache
+
+		foreach ($tpllist as $onetemplate) {    // Remove cache for each page.
+			if ($onetemplate->getVar('tpl_type') === 'module') {
+				//  Note, I've been testing all the other methods (like the one of Smarty) and none of them run, that's why I have used this code
+				$files_del = array();
+				$files_del = glob(XOOPS_CACHE_PATH . '/*' . $onetemplate->getVar('tpl_file') . '*');
+				if (count($files_del) > 0 && is_array($files_del)) {
+					foreach ($files_del as $one_file) {
+						if (is_file($one_file)) {
+							unlink($one_file);
+						}
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * Redirect user with a message
+	 *
+	 * @param string $message message to display
+	 * @param string $url     The place where to go
+	 * @param        integer  timeout Time to wait before to redirect
+	 */
+	public static function redirect($message = '', $url = 'index.php', $time = 2)
+	{
+		redirect_header($url, $time, $message);
+		exit();
+	}
+
+	/**
+	 * Internal function used to get the handler of the current module
+	 *
+	 * @return object The module
+	 */
+	public static function getModule()
+	{
+		static $mymodule;
+		if (!isset($mymodule)) {
+			global $xoopsModule;
+			if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == REFERENCES_DIRNAME) {
+				$mymodule =& $xoopsModule;
+			} else {
+				$hModule  = xoops_getHandler('module');
+				$mymodule = $hModule->getByDirname(REFERENCES_DIRNAME);
+			}
+		}
+
+		return $mymodule;
+	}
+
+	/**
+	 * Returns the module's name (as defined by the user in the module manager) with cache
+	 * @return string Module's name
+	 */
+	public static function getModuleName()
+	{
+		static $moduleName;
+		if (!isset($moduleName)) {
+			$mymodule   = self::getModule();
+			$moduleName = $mymodule->getVar('name');
+		}
+
+		return $moduleName;
+	}
+
+	/**
+	 * Create a title for the href tags inside html links
+	 *
+	 * @param  string $title Text to use
+	 * @return string Formated text
+	 */
+	public static function makeHrefTitle($title)
+	{
+		$s = "\"'";
+		$r = '  ';
+
+		return strtr($title, $s, $r);
+	}
+
+	/**
+	 * Retourne la liste des utilisateurs appartenants � un groupe
+	 *
+	 * @param  int $groupId Searched group
+	 * @return array Array of XoopsUsers
+	 */
+	public static function getUsersFromGroup($groupId)
+	{
+		$users          = array();
+		$member_handler = xoops_getHandler('member');
+		$users          = $member_handler->getUsersByGroup($groupId, true);
+
+		return $users;
+	}
+
+	/**
+	 * Retourne les ID des utilisateurs faisant partie de plusieurs groupes
+	 * @param  array $groups Les ID des groupes dont on recherche les ID utilisateurs
+	 * @return array Les ID utilisateurs
+	 */
+	public static function getUsersIdsFromGroups($groups)
+	{
+		$usersIds       = array();
+		$member_handler = xoops_getHandler('member');
+		foreach ($groups as $groupId) {
+			$temporaryGroup = array();
+			$temporaryGroup = $member_handler->getUsersByGroup($groupId);
+			if (count($temporaryGroup) > 0) {
+				$usersIds = array_merge($usersIds, $temporaryGroup);
+			}
+		}
+
+		return array_unique($usersIds);
+	}
+
+	/**
+	 * Retourne la liste des emails des utilisateurs membres d'un groupe
+	 *
+	 * @param $groupId
+	 * @return array Emails list
+	 * @internal param int $group_id Group's number
+	 */
+	public static function getEmailsFromGroup($groupId)
+	{
+		$ret   = array();
+		$users = self::getUsersFromGroup($groupId);
+		foreach ($users as $user) {
+			$ret[] = $user->getVar('email');
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * V�rifie que l'utilisateur courant fait partie du groupe des administrateurs
+	 *
+	 * @return booleean Admin or not
+	 */
+	public static function isAdmin()
+	{
+		global $xoopsUser, $xoopsModule;
+		if (is_object($xoopsUser)) {
+			if (in_array(XOOPS_GROUP_ADMIN, $xoopsUser->getGroups())) {
+				return true;
+			} elseif (isset($xoopsModule) && $xoopsUser->isAdmin($xoopsModule->getVar('mid'))) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Returns the current date in the Mysql format
+	 *
+	 * @return string Date in the Mysql format
+	 */
+	public static function getCurrentSQLDate()
+	{
+		return date('Y-m-d');    // 2007-05-02
+	}
+
+	public static function getCurrentSQLDateTime()
+	{
+		return date('Y-m-d H:i:s');    // 2007-05-02
+	}
+
+	/**
+	 * Convert a Mysql date to the human's format
+	 *
+	 * @param  string $date The date to convert
+	 * @param string  $format
+	 * @return string The date in a human form
+	 */
+	public static function SQLDateToHuman($date, $format = 'l')
+	{
+		if ($date != '0000-00-00' && xoops_trim($date) != '') {
+			return formatTimestamp(strtotime($date), $format);
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Convert a timestamp to a Mysql date
+	 *
+	 * @param  integer $timestamp The timestamp to use
+	 * @return string  The date in the Mysql format
+	 */
+	public static function timestampToMysqlDate($timestamp)
+	{
+		return date('Y-m-d', (int)$timestamp);
+	}
+
+	/**
+	 * Conversion d'un dateTime Mysql en date lisible en fran�ais
+	 * @param $dateTime
+	 * @return bool|string
+	 */
+	public static function sqlDateTimeToFrench($dateTime)
+	{
+		return date('d/m/Y H:i:s', strtotime($dateTime));
+	}
+
+	/**
+	 * Convert a timestamp to a Mysql datetime form
+	 * @param  integer $timestamp The timestamp to use
+	 * @return string  The date and time in the Mysql format
+	 */
+	public static function timestampToMysqlDateTime($timestamp)
+	{
+		return date('Y-m-d H:i:s', $timestamp);
+	}
+
+	/**
+	 * This function indicates if the current Xoops version needs to add asterisks to required fields in forms
+	 *
+	 * @return boolean Yes = we need to add them, false = no
+	 */
+	public static function needsAsterisk()
+	{
+		if (self::isX23()) {
+			return false;
+		}
+		if (strpos(strtolower(XOOPS_VERSION), 'impresscms') !== false) {
+			return false;
+		}
+		if (strpos(strtolower(XOOPS_VERSION), 'legacy') === false) {
+			$xv = xoops_trim(str_replace('XOOPS ', '', XOOPS_VERSION));
+			if ((int)substr($xv, 4, 2) >= 17) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Mark the mandatory fields of a form with a star
+	 *
+	 * @param  object $sform The form to modify
+	 * @return object The modified form
+	 * @internal param string $caracter The character to use to mark fields
+	 */
+	public static function &formMarkRequiredFields(&$sform)
+	{
+		if (self::needsAsterisk()) {
+			$required = array();
+			foreach ($sform->getRequired() as $item) {
+				$required[] = $item->_name;
+			}
+			$elements = array();
+			$elements = &$sform->getElements();
+			$cnt      = count($elements);
+			for ($i = 0; $i < $cnt; ++$i) {
+				if (is_object($elements[$i]) && in_array($elements[$i]->_name, $required)) {
+					$elements[$i]->_caption .= ' *';
+				}
+			}
+		}
+
+		return $sform;
+	}
+
+	/**
+	 * Create an html heading (from h1 to h6)
+	 *
+	 * @param  string  $title The text to use
+	 * @param  integer $level Level to return
+	 * @return string  The heading
+	 */
+	public static function htitle($title = '', $level = 1)
+	{
+		printf('<h%01d>%s</h%01d>', $level, $title, $level);
+	}
+
+	/**
+	 * Create a unique upload filename
+	 *
+	 * @param  string  $folder   The folder where the file will be saved
+	 * @param  string  $fileName Original filename (coming from the user)
+	 * @param  boolean $trimName Do we need to create a short unique name ?
+	 * @return string  The unique filename to use (with its extension)
+	 */
+	public static function createUploadName($folder, $fileName, $trimName = false)
+	{
+		$workingfolder = $folder;
+		if (substr($workingfolder, strlen($workingfolder) - 1, 1) !== '/') {
+			$workingfolder .= '/';
+		}
+		$ext  = basename($fileName);
+		$ext  = explode('.', $ext);
+		$ext  = '.' . $ext[count($ext) - 1];
+		$true = true;
+		while ($true) {
+			$ipbits = explode('.', $_SERVER['REMOTE_ADDR']);
+			list($usec, $sec) = explode(' ', microtime());
+			$usec = (integer)($usec * 65536);
+			$sec  = ((integer)$sec) & 0xFFFF;
+
+			if ($trimName) {
+				$uid = sprintf('%06x%04x%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
+			} else {
+				$uid = sprintf('%08x-%04x-%04x', ($ipbits[0] << 24) | ($ipbits[1] << 16) | ($ipbits[2] << 8) | $ipbits[3], $sec, $usec);
+			}
+			if (!file_exists($workingfolder . $uid . $ext)) {
+				$true = false;
+			}
+		}
+
+		return $uid . $ext;
+	}
+
+	/**
+	 * Replace html entities with their ASCII equivalent
+	 *
+	 * @param  string $chaine The string undecode
+	 * @return string The undecoded string
+	 */
+	public static function unhtml($chaine)
+	{
+		$search = $replace = array();
+		$chaine = html_entity_decode($chaine);
+
+		for ($i = 0; $i <= 255; ++$i) {
+			$search[]  = '&#' . $i . ';';
+			$replace[] = chr($i);
+		}
 		$replace[]='...'; $search[]='…';
 		$replace[]="'";	$search[]='‘';
 		$replace[]="'";	$search[]= '’';
@@ -806,765 +806,765 @@ 
 		$replace[]='Ý'; $search[]='&Yacute;';
 		$replace[]='ÿ'; $search[]='&yuml;';
 		$replace[]='Ÿ'; $search[]='&Yuml;';
-        $chaine    = str_replace($search, $replace, $chaine);
-
-        return $chaine;
-    }
-
-    /**
-     * Création d'une titre pour être utilisé par l'url rewriting
-     *
-     * @param string  $content  Le texte à utiliser pour créer l'url
-     * @param integer $urw      La limite basse pour créer les mots
-     * @return string Le texte à utiliser pour l'url
-     *                          Note, some parts are from Solo's code
-     */
-    public static function makeSeoUrl($content, $urw = 1)
-    {
-        $s       = "ÀÁÂÃÄÅÒÓÔÕÖØÈÉÊËÇÌÍÎÏÙÚÛÜŸÑàáâãäåòóôõöøèéêëçìíîïùúûüÿñ '()";
-        $r       = 'AAAAAAOOOOOOEEEECIIIIUUUUYNaaaaaaooooooeeeeciiiiuuuuyn----';
-        $content = self::unhtml($content);    // First, remove html entities
-        $content = strtr($content, $s, $r);
-        $content = strip_tags($content);
-        $content = strtolower($content);
-        $content = htmlentities($content);    // TODO: Vérifier
-        $content = preg_replace('/&([a-zA-Z])(uml|acute|grave|circ|tilde);/', '$1', $content);
-        $content = html_entity_decode($content);
-        $content = eregi_replace('quot', ' ', $content);
-        $content = eregi_replace("'", ' ', $content);
-        $content = eregi_replace('-', ' ', $content);
-        $content = eregi_replace('[[:punct:]]', '', $content);
-        // Selon option mais attention au fichier .htaccess !
-        // $content = eregi_replace('[[:digit:]]','', $content);
-        $content = preg_replace('/[^a-z|A-Z|0-9]/', '-', $content);
-
-        $words    = explode(' ', $content);
-        $keywords = '';
-        foreach ($words as $word) {
-            if (strlen($word) >= $urw) {
-                $keywords .= '-' . trim($word);
-            }
-        }
-        if (!$keywords) {
-            $keywords = '-';
-        }
-        // Supprime les tirets en double
-        $keywords = str_replace('---', '-', $keywords);
-        $keywords = str_replace('--', '-', $keywords);
-        // Supprime un éventuel tiret à la fin de la chaine
-        if (substr($keywords, strlen($keywords) - 1, 1) == '-') {
-            $keywords = substr($keywords, 0, strlen($keywords) - 1);
-        }
-
-        return $keywords;
-    }
-
-    /**
-     * Create the meta keywords based on the content
-     *
-     * @param  string $content Content from which we have to create metakeywords
-     * @return string The list of meta keywords
-     */
-    public static function createMetaKeywords($content)
-    {
-        $keywordscount = REFERENCES_METAGEN_MAX_KEYWORDS;
-        $keywordsorder = REFERENCES_METAGEN_KEYWORDS_ORDER;
-
-        $tmp = array();
-        // Search for the "Minimum keyword length"
-        // TODO: Remplacer references_keywords_limit par une constante
-        if (isset($_SESSION['references_keywords_limit'])) {
-            $limit = $_SESSION['references_keywords_limit'];
-        } else {
-            $config_handler                        = xoops_getHandler('config');
-            $xoopsConfigSearch                     =& $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
-            $limit                                 = $xoopsConfigSearch['keyword_min'];
-            $_SESSION['references_keywords_limit'] = $limit;
-        }
-        $myts            = MyTextSanitizer::getInstance();
-        $content         = str_replace('<br>', ' ', $content);
-        $content         = $myts->undoHtmlSpecialChars($content);
-        $content         = strip_tags($content);
-        $content         = strtolower($content);
-        $search_pattern  = array('&nbsp;', "\t", "\r\n", "\r", "\n", ',', '.', "'", ';', ':', ')', '(', '"', '?', '!', '{', '}', '[', ']', '<', '>', '/', '+', '-', '_', '\\', '*');
-        $replace_pattern = array(' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '');
-        $content         = str_replace($search_pattern, $replace_pattern, $content);
-        $keywords        = explode(' ', $content);
-        switch ($keywordsorder) {
-            case 0:    // Ordre d'apparition dans le texte
-                $keywords = array_unique($keywords);
-                break;
-            case 1:    // Ordre de fréquence des mots
-                $keywords = array_count_values($keywords);
-                asort($keywords);
-                $keywords = array_keys($keywords);
-                break;
-            case 2:    // Ordre inverse de la fréquence des mots
-                $keywords = array_count_values($keywords);
-                arsort($keywords);
-                $keywords = array_keys($keywords);
-                break;
-        }
-        // Remove black listed words
-        if (xoops_trim(self::getModuleOption('metagen_blacklist')) != '') {
-            $metagen_blacklist = str_replace("\r", '', self::getModuleOption('metagen_blacklist'));
-            $metablack         = explode("\n", $metagen_blacklist);
-            array_walk($metablack, 'trim');
-            $keywords = array_diff($keywords, $metablack);
-        }
-
-        foreach ($keywords as $keyword) {
-            if (strlen($keyword) >= $limit && !is_numeric($keyword)) {
-                $tmp[] = $keyword;
-            }
-        }
-        $tmp = array_slice($tmp, 0, $keywordscount);
-        if (count($tmp) > 0) {
-            return implode(',', $tmp);
-        } else {
-            if (!isset($config_handler) || !is_object($config_handler)) {
-                $config_handler = xoops_getHandler('config');
-            }
-            $xoopsConfigMetaFooter =& $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
-            if (isset($xoopsConfigMetaFooter['meta_keywords'])) {
-                return $xoopsConfigMetaFooter['meta_keywords'];
-            } else {
-                return '';
-            }
-        }
-    }
-
-    /**
-     * Fonction chargée de gérer l'upload
-     *
-     * @param integer $indice L'indice du fichier à télécharger
-     * @param string  $dstpath
-     * @param null    $mimeTypes
-     * @param null    $uploadMaxSize
-     * @param null    $maxWidth
-     * @param null    $maxHeight
-     * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
-     */
-    public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
-    {
-        require_once XOOPS_ROOT_PATH . '/class/uploader.php';
-        global $destname;
-        if (isset($_POST['xoops_upload_file'])) {
-            require_once XOOPS_ROOT_PATH . '/class/uploader.php';
-            $fldname = '';
-            $fldname = $_FILES[$_POST['xoops_upload_file'][$indice]];
-            $fldname = get_magic_quotes_gpc() ? stripslashes($fldname['name']) : $fldname['name'];
-            if (xoops_trim($fldname != '')) {
-                $destname = self::createUploadName($dstpath, $fldname, true);
-                if ($mimeTypes === null) {
-                    $permittedtypes = explode("\n", str_replace("\r", '', self::getModuleOption('mimetypes')));
-                    array_walk($permittedtypes, 'trim');
-                } else {
-                    $permittedtypes = $mimeTypes;
-                }
-                if ($uploadMaxSize === null) {
-                    $uploadSize = self::getModuleOption('maxuploadsize');
-                } else {
-                    $uploadSize = $uploadMaxSize;
-                }
-                $uploader = new XoopsMediaUploader($dstpath, $permittedtypes, $uploadSize, $maxWidth, $maxHeight);
-                //$uploader->allowUnknownTypes = true;
-                $uploader->setTargetFileName($destname);
-                if ($uploader->fetchMedia($_POST['xoops_upload_file'][$indice])) {
-                    if ($uploader->upload()) {
-                        return true;
-                    } else {
-                        return _ERRORS . ' ' . htmlentities($uploader->getErrors());
-                    }
-                } else {
-                    return htmlentities($uploader->getErrors());
-                }
-            } else {
-                return false;
-            }
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * Resize a Picture to some given dimensions (using the wideImage library)
-     *
-     * @param string  $src_path      Picture's source
-     * @param string  $dst_path      Picture's destination
-     * @param integer $param_width   Maximum picture's width
-     * @param integer $param_height  Maximum picture's height
-     * @param boolean $keep_original Do we have to keep the original picture ?
-     * @param string  $fit           Resize mode (see the wideImage library for more information)
-     * @return bool
-     */
-    public static function resizePicture($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
-    {
-        //        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
-        $img    = WideImage::load($src_path);
-        $result = $img->resize($param_width, $param_height, $fit);
-        $result->saveToFile($dst_path, null);
-        if (!$keep_original) {
-            @unlink($src_path);
-        }
-
-        return true;
-    }
-
-    /**
-     * Déclenchement d'une alerte Xoops suite à un évènement
-     *
-     * @param string       $category La catégorie de l'évènement
-     * @param integer      $itemId   L'ID de l'élément (trop général pour être décris précisément)
-     * @param unknown_type $event    L'évènement qui est déclencé
-     * @param unknown_type $tags     Les variables à passer au template
-     */
-    public static function notify($category, $itemId, $event, $tags)
-    {
-        $notification_handler = xoops_getHandler('notification');
-        $tags['X_MODULE_URL'] = REFERENCES_URL;
-        $notification_handler->triggerEvent($category, $itemId, $event, $tags);
-    }
-
-    /**
-     * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
-     *
-     * @param int     $duration
-     * @param integer $startingDate Date de départ (timestamp)
-     * @return bool|string
-     * @internal param int $durations Durée en jours
-     */
-    public static function addDaysToDate($duration = 1, $startingDate = 0)
-    {
-        if ($startingDate == 0) {
-            $startingDate = time();
-        }
-        $endingDate = $startingDate + ($duration * 86400);
-
-        return date('Y-m-d', $endingDate);
-    }
-
-    /**
-     * Retourne un breadcrumb en fonction des paramètres passés et en partant (d'office) de la racine du module
-     *
-     * @param array  $path  Le chemin complet (excepté la racine) du breadcrumb sous la forme clé=url valeur=titre
-     * @param string $raquo Le séparateur par défaut à utiliser
-     * @return string le breadcrumb
-     */
-    public static function breadcrumb($path, $raquo = ' &raquo; ')
-    {
-        $breadcrumb        = '';
-        $workingBreadcrumb = array();
-        if (is_array($path)) {
-            $moduleName          = self::getModuleName();
-            $workingBreadcrumb[] = "<a href='" . REFERENCES_URL . "' title='" . self::makeHrefTitle($moduleName) . "'>" . $moduleName . '</a>';
-            foreach ($path as $url => $title) {
-                $workingBreadcrumb[] = "<a href='" . $url . "'>" . $title . '</a>';
-            }
-            $cnt = count($workingBreadcrumb);
-            for ($i = 0; $i < $cnt; ++$i) {
-                if ($i == $cnt - 1) {
-                    $workingBreadcrumb[$i] = strip_tags($workingBreadcrumb[$i]);
-                }
-            }
-            $breadcrumb = implode($raquo, $workingBreadcrumb);
-        }
-
-        return $breadcrumb;
-    }
-
-    public static function close_tags($string)
-    {
-        // match opened tags
-        if (preg_match_all('/<([a-z\:\-]+)[^\/]>/', $string, $start_tags)) {
-            $start_tags = $start_tags[1];
-
-            // match closed tags
-            if (preg_match_all('/<\/([a-z]+)>/', $string, $end_tags)) {
-                $complete_tags = array();
-                $end_tags      = $end_tags[1];
-
-                foreach ($start_tags as $key => $val) {
-                    $posb = array_search($val, $end_tags);
-                    if (is_int($posb)) {
-                        unset($end_tags[$posb]);
-                    } else {
-                        $complete_tags[] = $val;
-                    }
-                }
-            } else {
-                $complete_tags = $start_tags;
-            }
-
-            $complete_tags = array_reverse($complete_tags);
-            for ($i = 0; $i < count($complete_tags); ++$i) {
-                $string .= '</' . $complete_tags[$i] . '>';
-            }
-        }
-
-        return $string;
-    }
-
-    public static function truncate_tagsafe($string, $length = 80, $etc = '...', $break_words = false)
-    {
-        if ($length == 0) {
-            return '';
-        }
-
-        if (strlen($string) > $length) {
-            $length -= strlen($etc);
-            if (!$break_words) {
-                $string = preg_replace('/\s+?(\S+)?$/', '', substr($string, 0, $length + 1));
-                $string = preg_replace('/<[^>]*$/', '', $string);
-                $string = self::close_tags($string);
-            }
-
-            return $string . $etc;
-        } else {
-            return $string;
-        }
-    }
-
-    /**
-     * Create an infotip
-     * @param $text
-     * @return string
-     */
-    public static function makeInfotips($text)
-    {
-        $ret      = '';
-        $infotips = self::getModuleOption('infotips');
-        if ($infotips > 0) {
-            $myts = MyTextSanitizer::getInstance();
-            $ret  = $myts->htmlSpecialChars(substr(strip_tags($text), 0, $infotips));
-        }
-
-        return $ret;
-    }
-
-    /**
-     * Retourne le type Mime d'un fichier en utilisant d'abord finfo puis mime_content
-     *
-     * @param string $filename Le fichier (avec son chemin d'accès complet) dont on veut connaître le type mime
-     * @return string
-     */
-    public static function getMimeType($filename)
-    {
-        if (function_exists('finfo_open')) {
-            $pathToMagic = REFERENCES_PATH . 'mime/magic';
-            $finfo       = new finfo(FILEINFO_MIME, $pathToMagic);
-            $mimetype    = $finfo->file($filename);
-            finfo_close($finfo);
-            unset($finfo);
-
-            return $mimetype;
-        } else {
-            if (function_exists('mime_content_type')) {
-                return mime_content_type($filename);
-            } else {
-                return '';
-            }
-        }
-    }
-
-    /**
-     * Retourne une liste d'objets XoopsUsers à partir d'une liste d'identifiants
-     *
-     * @param  array $xoopsUsersIDs La liste des ID
-     * @return array Les objets XoopsUsers
-     */
-    public static function getUsersFromIds($xoopsUsersIDs)
-    {
-        $users = array();
-        if (is_array($xoopsUsersIDs) && count($xoopsUsersIDs) > 0) {
-            $xoopsUsersIDs = array_unique($xoopsUsersIDs);
-            sort($xoopsUsersIDs);
-            if (count($xoopsUsersIDs) > 0) {
-                $member_handler = xoops_getHandler('user');
-                $criteria       = new Criteria('uid', '(' . implode(',', $xoopsUsersIDs) . ')', 'IN');
-                $criteria->setSort('uid');
-                $users = $member_handler->getObjects($criteria, true);
-            }
-        }
-
-        return $users;
-    }
-
-    /**
-     * Retourne l'ID de l'utilisateur courant (s'il est connecté)
-     * @return integer L'uid ou 0
-     */
-    public static function getCurrentUserID()
-    {
-        global $xoopsUser;
-        $uid = is_object($xoopsUser) ? $xoopsUser->getVar('uid') : 0;
-
-        return $uid;
-    }
-
-    /**
-     * Retourne la liste des groupes de l'utilisateur courant (avec cache)
-     * @param int $uid
-     * @return array Les ID des groupes auquel l'utilisateur courant appartient
-     */
-    public static function getMemberGroups($uid = 0)
-    {
-        static $buffer = array();
-        if ($uid == 0) {
-            $uid = self::getCurrentUserID();
-        }
-
-        if (is_array($buffer) && count($buffer) > 0 && isset($buffer[$uid])) {
-            return $buffer[$uid];
-        } else {
-            if ($uid > 0) {
-                $member_handler = xoops_getHandler('member');
-                $buffer[$uid]   = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
-            } else {
-                $buffer[$uid] = array(XOOPS_GROUP_ANONYMOUS);
-            }
-        }
-
-        return $buffer[$uid];
-    }
-
-    /**
-     * Indique si l'utilisateur courant fait partie d'une groupe donné (avec gestion de cache)
-     *
-     * @param integer $group Groupe recherché
-     * @param int     $uid
-     * @return bool vrai si l'utilisateur fait partie du groupe, faux sinon
-     */
-    public static function isMemberOfGroup($group = 0, $uid = 0)
-    {
-        static $buffer = array();
-        $retval = false;
-        if ($uid == 0) {
-            $uid = self::getCurrentUserID();
-        }
-        if (is_array($buffer) && array_key_exists($group, $buffer)) {
-            $retval = $buffer[$group];
-        } else {
-            $member_handler = xoops_getHandler('member');
-            $groups         = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
-            $retval         = in_array($group, $groups);
-            $buffer[$group] = $retval;
-        }
-
-        return $retval;
-    }
-
-    /**
-     * Indique si un utilisateur fait partie de plusieurs groupes
-     * La fonction renvoie vrai dès qu'on trouve que le membre fait partir d'un des groupes
-     * @param array    $groups La liste des groupes à vérifier
-     * @param  integer $uid    L'ID de l'utilisateur
-     * @return boolean
-     */
-    public static function isMemberOfGroups($groups, $uid = 0)
-    {
-        if (count($groups) == 0) {
-            return false;
-        }
-        if ($uid == 0) {
-            $uid = self::getCurrentUserID();
-        }
-        foreach ($groups as $groupId) {
-            if (self::isMemberOfGroup($groupId, $uid)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Retourne le nombre total de groupes (y compris les anonymes)
-     */
-    public static function getGroupsCount()
-    {
-        static $cache = -1;
-        if ($cache == -1) {
-            global $xoopsDB;
-            $sql    = 'SELECT COUNT(*) FROM ' . $xoopsDB->prefix('groups');
-            $result = $xoopsDB->query($sql);
-            if (!$result) {
-                return false;
-            }
-            list($cache) = $xoopsDB->fetchRow($result);
-        }
-
-        return $cache;
-    }
-
-    /**
-     * Fonction chargée de vérifier qu'un répertoire existe, qu'on peut écrire dedans et création d'un fichier index.html
-     *
-     * @param string $folder Le chemin complet du répertoire à vérifier
-     * @return void
-     */
-    public static function prepareFolder($folder)
-    {
-        if (!is_dir($folder)) {
-            mkdir($folder, 0777);
-            file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
-        } else {
-            if (!is_writable($folder)) {
-                chmod($folder, 0777);
-            }
-        }
-    }
-
-    /**
-     * Load a language file
-     *
-     * @param string $languageFile     The required language file
-     * @param string $defaultExtension Default extension to use
-     */
-    public static function loadLanguageFile($languageFile, $defaultExtension = '.php')
-    {
-        global $xoopsConfig;
-        $root = self::MODULE_PATH;
-        if (strstr($languageFile, $defaultExtension) === false) {
-            $languageFile .= $defaultExtension;
-        }
-        if (file_exists($root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile)) {
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile;
-        } else {    // Fallback
-            require_once $root . 'language' . DIRECTORY_SEPARATOR . 'english' . DIRECTORY_SEPARATOR . $languageFile;
-        }
-    }
-
-    /**
-     * Création d'une vignette en tenant compte des options du module concernant le mode de création des vignettes
-     *
-     * @param  string  $src_path
-     * @param  string  $dst_path
-     * @param  integer $param_width
-     * @param  integer $param_height
-     * @param  boolean $keep_original
-     * @param string   $fit Utilisé uniquement pour la méthode 0 (redimensionnement)
-     * @return boolean
-     */
-    public static function createThumb($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
-    {
-        //        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
-        $resize = true;
-        // On commence par vérifier que l'image originale n'est pas plus petite que les dimensions demandées auquel cas il n'y a rien à faire
-        $pictureDimensions = getimagesize($src_path);
-        if (is_array($pictureDimensions)) {
-            $pictureWidth  = $pictureDimensions[0];
-            $pictureHeight = $pictureDimensions[1];
-            if ($pictureWidth < $param_width && $pictureHeight < $param_height) {
-                $resize = false;
-            }
-        }
-        $img = WideImage::load($src_path);
-        if ($resize) { // L'image est suffisament grande pour être réduite
-            $thumbMethod = 0;
-            if ($thumbMethod == 0) { // Redimensionnement de l'image
-                $result = $img->resize($param_width, $param_height, $fit);
-            } else { // Récupération d'une partie de l'image depuis le centre
-                // Calcul de left et top
-                $left = $top = 0;
-                if (is_array($pictureDimensions)) {
-                    if ($pictureWidth > $param_width) {
-                        $left = (int)(($pictureWidth / 2) - ($param_width / 2));
-                    }
-                    if ($pictureHeight > $param_height) {
-                        $top = (int)(($pictureHeight / 2) - ($param_height / 2));
-                    }
-                }
-                $result = $img->crop($left, $top, $param_width, $param_height);
-            }
-            $result->saveToFile($dst_path, null);
-        } else {
-            if ($src_path != $dst_path) {
-                @copy($src_path, $dst_path);
-            }
-        }
-        if (!$keep_original) {
-            @unlink($src_path);
-        }
-
-        return true;
-    }
-
-    /**
-     * Create the <option> of an html select
-     *
-     * @param  array $array   Array of index and labels
-     * @param  mixed $default the default value
-     * @param bool   $withNull
-     * @return string
-     */
-    private static function htmlSelectOptions($array, $default = 0, $withNull = true)
-    {
-        $ret      = array();
-        $selected = '';
-        if ($withNull) {
-            if (!is_array($default)) {
-                if ($default === 0) {
-                    $selected = " selected = 'selected'";
-                }
-            } else {
-                if (in_array(0, $default)) {
-                    $selected = " selected = 'selected'";
-                }
-            }
-            $ret[] = '<option value=0' . $selected . '>---</option>';
-        }
-
-        foreach ($array as $index => $label) {
-            $selected = '';
-            if (!is_array($default)) {
-                if ($index == $default) {
-                    $selected = " selected = 'selected'";
-                }
-            } else {
-                if (in_array($index, $default)) {
-                    $selected = " selected = 'selected'";
-                }
-            }
-            $ret[] = "<option value=\"" . $index . "\"" . $selected . '>' . $label . '</option>';
-        }
-
-        return implode("\n", $ret);
-    }
-
-    /**
-     * Creates an html select an returns its code
-     *
-     * @param  string  $selectName Select's name
-     * @param  array   $array      Key = value of each option, value = label of each option
-     * @param  mixed   $default    Default's value
-     * @param  boolean $withNull   Do we want a null option
-     * @param  string  $style      Is there a style to apply ?
-     * @param  boolean $multiple   Can we select multiple elements ?
-     * @param  integer $size       Size of the selectbox, only used with multiple selectboxes
-     * @param string   $extra
-     * @return string
-     */
-    public static function htmlSelect($selectName, $array, $default, $withNull = true, $style = '', $multiple = false, $size = 1, $extra = '')
-    {
-        $ret = '';
-        $ret .= "<select name='" . $selectName . "' id='" . $selectName . "'";
-        if (xoops_trim($style) != '') {
-            $ret .= " style='" . $style . "' ";
-        }
-        if (xoops_trim($multiple) != '') {
-            $ret .= " multiple = 'multiple' size='" . $size . "' ";
-        }
-        $ret .= $extra . ">\n";
-        $ret .= self::htmlSelectOptions($array, $default, $withNull);
-        $ret .= "</select>\n";
-
-        return $ret;
-    }
-
-    /**
-     * Verify that a mysql table exists
-     * @param $tablename
-     * @return bool
-     */
-    public static function tableExists($tablename)
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");
-
-        return ($xoopsDB->getRowsNum($result) > 0);
-    }
-
-    /**
-     * Verify that a field exists inside a mysql table
-     * @param $fieldname
-     * @param $table
-     * @return bool
-     */
-    public static function fieldExists($fieldname, $table)
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
-
-        return ($xoopsDB->getRowsNum($result) > 0);
-    }
-
-    /**
-     * Retourne la définition d'un champ
-     *
-     * @param  string $fieldname
-     * @param  string $table
-     * @return array
-     */
-    public static function getFieldDefinition($fieldname, $table)
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
-        if ($result) {
-            return $xoopsDB->fetchArray($result);
-        }
-
-        return '';
-    }
-
-    /**
-     * Add a field to a mysql table
-     * @param $field
-     * @param $table
-     * @return resource
-     */
-    public static function addField($field, $table)
-    {
-        global $xoopsDB;
-        $result = $xoopsDB->queryF("ALTER TABLE $table ADD $field;");
-
-        return $result;
-    }
-
-    /**
-     * Maintenance des tables du module et de son cache de requêtes
-     *
-     * @return void
-     */
-    public static function maintainTablesCache()
-    {
-        global $xoopsDB;
-        define('REFERENCES_MAINTAIN', true);
-        require self::MODULE_PATH . 'xoops_version.php';
-        $tables = array();
-        foreach ($modversion['tables'] as $table) {
-            $tables[] = $xoopsDB->prefix($table);
-        }
-        if (count($tables) > 0) {
-            $list = implode(',', $tables);
-            $xoopsDB->queryF('CHECK TABLE ' . $list);
-            $xoopsDB->queryF('ANALYZE TABLE ' . $list);
-            $xoopsDB->queryF('OPTIMIZE TABLE ' . $list);
-        }
-        self::updateCache();
-        $handlers = references_handler::getInstance();
-        $handlers->h_references_articles->forceCacheClean();
-    }
-
-    /**
-     * Indique si le module Tag existe et est activé
-     *
-     * @return boolean
-     * @credit: smartfactory
-     */
-    public static function tagModuleExists()
-    {
-        static $moduleExistsAndIsActive;
-        if (!isset($moduleExistsAndIsActive)) {
-            $modules_handler = xoops_getHandler('module');
-            $tagModule       = $modules_handler->getByDirName('tag');
-            if (!$tagModule) {
-                $moduleExistsAndIsActive = false;
-            } else {
-                $moduleExistsAndIsActive = $tagModule->getVar('isactive') == 1;
-            }
-        }
-
-        return $moduleExistsAndIsActive;
-    }
+		$chaine    = str_replace($search, $replace, $chaine);
+
+		return $chaine;
+	}
+
+	/**
+	 * Création d'une titre pour être utilisé par l'url rewriting
+	 *
+	 * @param string  $content  Le texte à utiliser pour créer l'url
+	 * @param integer $urw      La limite basse pour créer les mots
+	 * @return string Le texte à utiliser pour l'url
+	 *                          Note, some parts are from Solo's code
+	 */
+	public static function makeSeoUrl($content, $urw = 1)
+	{
+		$s       = "ÀÁÂÃÄÅÒÓÔÕÖØÈÉÊËÇÌÍÎÏÙÚÛÜŸÑàáâãäåòóôõöøèéêëçìíîïùúûüÿñ '()";
+		$r       = 'AAAAAAOOOOOOEEEECIIIIUUUUYNaaaaaaooooooeeeeciiiiuuuuyn----';
+		$content = self::unhtml($content);    // First, remove html entities
+		$content = strtr($content, $s, $r);
+		$content = strip_tags($content);
+		$content = strtolower($content);
+		$content = htmlentities($content);    // TODO: Vérifier
+		$content = preg_replace('/&([a-zA-Z])(uml|acute|grave|circ|tilde);/', '$1', $content);
+		$content = html_entity_decode($content);
+		$content = eregi_replace('quot', ' ', $content);
+		$content = eregi_replace("'", ' ', $content);
+		$content = eregi_replace('-', ' ', $content);
+		$content = eregi_replace('[[:punct:]]', '', $content);
+		// Selon option mais attention au fichier .htaccess !
+		// $content = eregi_replace('[[:digit:]]','', $content);
+		$content = preg_replace('/[^a-z|A-Z|0-9]/', '-', $content);
+
+		$words    = explode(' ', $content);
+		$keywords = '';
+		foreach ($words as $word) {
+			if (strlen($word) >= $urw) {
+				$keywords .= '-' . trim($word);
+			}
+		}
+		if (!$keywords) {
+			$keywords = '-';
+		}
+		// Supprime les tirets en double
+		$keywords = str_replace('---', '-', $keywords);
+		$keywords = str_replace('--', '-', $keywords);
+		// Supprime un éventuel tiret à la fin de la chaine
+		if (substr($keywords, strlen($keywords) - 1, 1) == '-') {
+			$keywords = substr($keywords, 0, strlen($keywords) - 1);
+		}
+
+		return $keywords;
+	}
+
+	/**
+	 * Create the meta keywords based on the content
+	 *
+	 * @param  string $content Content from which we have to create metakeywords
+	 * @return string The list of meta keywords
+	 */
+	public static function createMetaKeywords($content)
+	{
+		$keywordscount = REFERENCES_METAGEN_MAX_KEYWORDS;
+		$keywordsorder = REFERENCES_METAGEN_KEYWORDS_ORDER;
+
+		$tmp = array();
+		// Search for the "Minimum keyword length"
+		// TODO: Remplacer references_keywords_limit par une constante
+		if (isset($_SESSION['references_keywords_limit'])) {
+			$limit = $_SESSION['references_keywords_limit'];
+		} else {
+			$config_handler                        = xoops_getHandler('config');
+			$xoopsConfigSearch                     =& $config_handler->getConfigsByCat(XOOPS_CONF_SEARCH);
+			$limit                                 = $xoopsConfigSearch['keyword_min'];
+			$_SESSION['references_keywords_limit'] = $limit;
+		}
+		$myts            = MyTextSanitizer::getInstance();
+		$content         = str_replace('<br>', ' ', $content);
+		$content         = $myts->undoHtmlSpecialChars($content);
+		$content         = strip_tags($content);
+		$content         = strtolower($content);
+		$search_pattern  = array('&nbsp;', "\t", "\r\n", "\r", "\n", ',', '.', "'", ';', ':', ')', '(', '"', '?', '!', '{', '}', '[', ']', '<', '>', '/', '+', '-', '_', '\\', '*');
+		$replace_pattern = array(' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '');
+		$content         = str_replace($search_pattern, $replace_pattern, $content);
+		$keywords        = explode(' ', $content);
+		switch ($keywordsorder) {
+			case 0:    // Ordre d'apparition dans le texte
+				$keywords = array_unique($keywords);
+				break;
+			case 1:    // Ordre de fréquence des mots
+				$keywords = array_count_values($keywords);
+				asort($keywords);
+				$keywords = array_keys($keywords);
+				break;
+			case 2:    // Ordre inverse de la fréquence des mots
+				$keywords = array_count_values($keywords);
+				arsort($keywords);
+				$keywords = array_keys($keywords);
+				break;
+		}
+		// Remove black listed words
+		if (xoops_trim(self::getModuleOption('metagen_blacklist')) != '') {
+			$metagen_blacklist = str_replace("\r", '', self::getModuleOption('metagen_blacklist'));
+			$metablack         = explode("\n", $metagen_blacklist);
+			array_walk($metablack, 'trim');
+			$keywords = array_diff($keywords, $metablack);
+		}
+
+		foreach ($keywords as $keyword) {
+			if (strlen($keyword) >= $limit && !is_numeric($keyword)) {
+				$tmp[] = $keyword;
+			}
+		}
+		$tmp = array_slice($tmp, 0, $keywordscount);
+		if (count($tmp) > 0) {
+			return implode(',', $tmp);
+		} else {
+			if (!isset($config_handler) || !is_object($config_handler)) {
+				$config_handler = xoops_getHandler('config');
+			}
+			$xoopsConfigMetaFooter =& $config_handler->getConfigsByCat(XOOPS_CONF_METAFOOTER);
+			if (isset($xoopsConfigMetaFooter['meta_keywords'])) {
+				return $xoopsConfigMetaFooter['meta_keywords'];
+			} else {
+				return '';
+			}
+		}
+	}
+
+	/**
+	 * Fonction chargée de gérer l'upload
+	 *
+	 * @param integer $indice L'indice du fichier à télécharger
+	 * @param string  $dstpath
+	 * @param null    $mimeTypes
+	 * @param null    $uploadMaxSize
+	 * @param null    $maxWidth
+	 * @param null    $maxHeight
+	 * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
+	 */
+	public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
+	{
+		require_once XOOPS_ROOT_PATH . '/class/uploader.php';
+		global $destname;
+		if (isset($_POST['xoops_upload_file'])) {
+			require_once XOOPS_ROOT_PATH . '/class/uploader.php';
+			$fldname = '';
+			$fldname = $_FILES[$_POST['xoops_upload_file'][$indice]];
+			$fldname = get_magic_quotes_gpc() ? stripslashes($fldname['name']) : $fldname['name'];
+			if (xoops_trim($fldname != '')) {
+				$destname = self::createUploadName($dstpath, $fldname, true);
+				if ($mimeTypes === null) {
+					$permittedtypes = explode("\n", str_replace("\r", '', self::getModuleOption('mimetypes')));
+					array_walk($permittedtypes, 'trim');
+				} else {
+					$permittedtypes = $mimeTypes;
+				}
+				if ($uploadMaxSize === null) {
+					$uploadSize = self::getModuleOption('maxuploadsize');
+				} else {
+					$uploadSize = $uploadMaxSize;
+				}
+				$uploader = new XoopsMediaUploader($dstpath, $permittedtypes, $uploadSize, $maxWidth, $maxHeight);
+				//$uploader->allowUnknownTypes = true;
+				$uploader->setTargetFileName($destname);
+				if ($uploader->fetchMedia($_POST['xoops_upload_file'][$indice])) {
+					if ($uploader->upload()) {
+						return true;
+					} else {
+						return _ERRORS . ' ' . htmlentities($uploader->getErrors());
+					}
+				} else {
+					return htmlentities($uploader->getErrors());
+				}
+			} else {
+				return false;
+			}
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Resize a Picture to some given dimensions (using the wideImage library)
+	 *
+	 * @param string  $src_path      Picture's source
+	 * @param string  $dst_path      Picture's destination
+	 * @param integer $param_width   Maximum picture's width
+	 * @param integer $param_height  Maximum picture's height
+	 * @param boolean $keep_original Do we have to keep the original picture ?
+	 * @param string  $fit           Resize mode (see the wideImage library for more information)
+	 * @return bool
+	 */
+	public static function resizePicture($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
+	{
+		//        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
+		$img    = WideImage::load($src_path);
+		$result = $img->resize($param_width, $param_height, $fit);
+		$result->saveToFile($dst_path, null);
+		if (!$keep_original) {
+			@unlink($src_path);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Déclenchement d'une alerte Xoops suite à un évènement
+	 *
+	 * @param string       $category La catégorie de l'évènement
+	 * @param integer      $itemId   L'ID de l'élément (trop général pour être décris précisément)
+	 * @param unknown_type $event    L'évènement qui est déclencé
+	 * @param unknown_type $tags     Les variables à passer au template
+	 */
+	public static function notify($category, $itemId, $event, $tags)
+	{
+		$notification_handler = xoops_getHandler('notification');
+		$tags['X_MODULE_URL'] = REFERENCES_URL;
+		$notification_handler->triggerEvent($category, $itemId, $event, $tags);
+	}
+
+	/**
+	 * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
+	 *
+	 * @param int     $duration
+	 * @param integer $startingDate Date de départ (timestamp)
+	 * @return bool|string
+	 * @internal param int $durations Durée en jours
+	 */
+	public static function addDaysToDate($duration = 1, $startingDate = 0)
+	{
+		if ($startingDate == 0) {
+			$startingDate = time();
+		}
+		$endingDate = $startingDate + ($duration * 86400);
+
+		return date('Y-m-d', $endingDate);
+	}
+
+	/**
+	 * Retourne un breadcrumb en fonction des paramètres passés et en partant (d'office) de la racine du module
+	 *
+	 * @param array  $path  Le chemin complet (excepté la racine) du breadcrumb sous la forme clé=url valeur=titre
+	 * @param string $raquo Le séparateur par défaut à utiliser
+	 * @return string le breadcrumb
+	 */
+	public static function breadcrumb($path, $raquo = ' &raquo; ')
+	{
+		$breadcrumb        = '';
+		$workingBreadcrumb = array();
+		if (is_array($path)) {
+			$moduleName          = self::getModuleName();
+			$workingBreadcrumb[] = "<a href='" . REFERENCES_URL . "' title='" . self::makeHrefTitle($moduleName) . "'>" . $moduleName . '</a>';
+			foreach ($path as $url => $title) {
+				$workingBreadcrumb[] = "<a href='" . $url . "'>" . $title . '</a>';
+			}
+			$cnt = count($workingBreadcrumb);
+			for ($i = 0; $i < $cnt; ++$i) {
+				if ($i == $cnt - 1) {
+					$workingBreadcrumb[$i] = strip_tags($workingBreadcrumb[$i]);
+				}
+			}
+			$breadcrumb = implode($raquo, $workingBreadcrumb);
+		}
+
+		return $breadcrumb;
+	}
+
+	public static function close_tags($string)
+	{
+		// match opened tags
+		if (preg_match_all('/<([a-z\:\-]+)[^\/]>/', $string, $start_tags)) {
+			$start_tags = $start_tags[1];
+
+			// match closed tags
+			if (preg_match_all('/<\/([a-z]+)>/', $string, $end_tags)) {
+				$complete_tags = array();
+				$end_tags      = $end_tags[1];
+
+				foreach ($start_tags as $key => $val) {
+					$posb = array_search($val, $end_tags);
+					if (is_int($posb)) {
+						unset($end_tags[$posb]);
+					} else {
+						$complete_tags[] = $val;
+					}
+				}
+			} else {
+				$complete_tags = $start_tags;
+			}
+
+			$complete_tags = array_reverse($complete_tags);
+			for ($i = 0; $i < count($complete_tags); ++$i) {
+				$string .= '</' . $complete_tags[$i] . '>';
+			}
+		}
+
+		return $string;
+	}
+
+	public static function truncate_tagsafe($string, $length = 80, $etc = '...', $break_words = false)
+	{
+		if ($length == 0) {
+			return '';
+		}
+
+		if (strlen($string) > $length) {
+			$length -= strlen($etc);
+			if (!$break_words) {
+				$string = preg_replace('/\s+?(\S+)?$/', '', substr($string, 0, $length + 1));
+				$string = preg_replace('/<[^>]*$/', '', $string);
+				$string = self::close_tags($string);
+			}
+
+			return $string . $etc;
+		} else {
+			return $string;
+		}
+	}
+
+	/**
+	 * Create an infotip
+	 * @param $text
+	 * @return string
+	 */
+	public static function makeInfotips($text)
+	{
+		$ret      = '';
+		$infotips = self::getModuleOption('infotips');
+		if ($infotips > 0) {
+			$myts = MyTextSanitizer::getInstance();
+			$ret  = $myts->htmlSpecialChars(substr(strip_tags($text), 0, $infotips));
+		}
+
+		return $ret;
+	}
+
+	/**
+	 * Retourne le type Mime d'un fichier en utilisant d'abord finfo puis mime_content
+	 *
+	 * @param string $filename Le fichier (avec son chemin d'accès complet) dont on veut connaître le type mime
+	 * @return string
+	 */
+	public static function getMimeType($filename)
+	{
+		if (function_exists('finfo_open')) {
+			$pathToMagic = REFERENCES_PATH . 'mime/magic';
+			$finfo       = new finfo(FILEINFO_MIME, $pathToMagic);
+			$mimetype    = $finfo->file($filename);
+			finfo_close($finfo);
+			unset($finfo);
+
+			return $mimetype;
+		} else {
+			if (function_exists('mime_content_type')) {
+				return mime_content_type($filename);
+			} else {
+				return '';
+			}
+		}
+	}
+
+	/**
+	 * Retourne une liste d'objets XoopsUsers à partir d'une liste d'identifiants
+	 *
+	 * @param  array $xoopsUsersIDs La liste des ID
+	 * @return array Les objets XoopsUsers
+	 */
+	public static function getUsersFromIds($xoopsUsersIDs)
+	{
+		$users = array();
+		if (is_array($xoopsUsersIDs) && count($xoopsUsersIDs) > 0) {
+			$xoopsUsersIDs = array_unique($xoopsUsersIDs);
+			sort($xoopsUsersIDs);
+			if (count($xoopsUsersIDs) > 0) {
+				$member_handler = xoops_getHandler('user');
+				$criteria       = new Criteria('uid', '(' . implode(',', $xoopsUsersIDs) . ')', 'IN');
+				$criteria->setSort('uid');
+				$users = $member_handler->getObjects($criteria, true);
+			}
+		}
+
+		return $users;
+	}
+
+	/**
+	 * Retourne l'ID de l'utilisateur courant (s'il est connecté)
+	 * @return integer L'uid ou 0
+	 */
+	public static function getCurrentUserID()
+	{
+		global $xoopsUser;
+		$uid = is_object($xoopsUser) ? $xoopsUser->getVar('uid') : 0;
+
+		return $uid;
+	}
+
+	/**
+	 * Retourne la liste des groupes de l'utilisateur courant (avec cache)
+	 * @param int $uid
+	 * @return array Les ID des groupes auquel l'utilisateur courant appartient
+	 */
+	public static function getMemberGroups($uid = 0)
+	{
+		static $buffer = array();
+		if ($uid == 0) {
+			$uid = self::getCurrentUserID();
+		}
+
+		if (is_array($buffer) && count($buffer) > 0 && isset($buffer[$uid])) {
+			return $buffer[$uid];
+		} else {
+			if ($uid > 0) {
+				$member_handler = xoops_getHandler('member');
+				$buffer[$uid]   = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
+			} else {
+				$buffer[$uid] = array(XOOPS_GROUP_ANONYMOUS);
+			}
+		}
+
+		return $buffer[$uid];
+	}
+
+	/**
+	 * Indique si l'utilisateur courant fait partie d'une groupe donné (avec gestion de cache)
+	 *
+	 * @param integer $group Groupe recherché
+	 * @param int     $uid
+	 * @return bool vrai si l'utilisateur fait partie du groupe, faux sinon
+	 */
+	public static function isMemberOfGroup($group = 0, $uid = 0)
+	{
+		static $buffer = array();
+		$retval = false;
+		if ($uid == 0) {
+			$uid = self::getCurrentUserID();
+		}
+		if (is_array($buffer) && array_key_exists($group, $buffer)) {
+			$retval = $buffer[$group];
+		} else {
+			$member_handler = xoops_getHandler('member');
+			$groups         = $member_handler->getGroupsByUser($uid, false);    // Renvoie un tableau d'ID (de groupes)
+			$retval         = in_array($group, $groups);
+			$buffer[$group] = $retval;
+		}
+
+		return $retval;
+	}
+
+	/**
+	 * Indique si un utilisateur fait partie de plusieurs groupes
+	 * La fonction renvoie vrai dès qu'on trouve que le membre fait partir d'un des groupes
+	 * @param array    $groups La liste des groupes à vérifier
+	 * @param  integer $uid    L'ID de l'utilisateur
+	 * @return boolean
+	 */
+	public static function isMemberOfGroups($groups, $uid = 0)
+	{
+		if (count($groups) == 0) {
+			return false;
+		}
+		if ($uid == 0) {
+			$uid = self::getCurrentUserID();
+		}
+		foreach ($groups as $groupId) {
+			if (self::isMemberOfGroup($groupId, $uid)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Retourne le nombre total de groupes (y compris les anonymes)
+	 */
+	public static function getGroupsCount()
+	{
+		static $cache = -1;
+		if ($cache == -1) {
+			global $xoopsDB;
+			$sql    = 'SELECT COUNT(*) FROM ' . $xoopsDB->prefix('groups');
+			$result = $xoopsDB->query($sql);
+			if (!$result) {
+				return false;
+			}
+			list($cache) = $xoopsDB->fetchRow($result);
+		}
+
+		return $cache;
+	}
+
+	/**
+	 * Fonction chargée de vérifier qu'un répertoire existe, qu'on peut écrire dedans et création d'un fichier index.html
+	 *
+	 * @param string $folder Le chemin complet du répertoire à vérifier
+	 * @return void
+	 */
+	public static function prepareFolder($folder)
+	{
+		if (!is_dir($folder)) {
+			mkdir($folder, 0777);
+			file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
+		} else {
+			if (!is_writable($folder)) {
+				chmod($folder, 0777);
+			}
+		}
+	}
+
+	/**
+	 * Load a language file
+	 *
+	 * @param string $languageFile     The required language file
+	 * @param string $defaultExtension Default extension to use
+	 */
+	public static function loadLanguageFile($languageFile, $defaultExtension = '.php')
+	{
+		global $xoopsConfig;
+		$root = self::MODULE_PATH;
+		if (strstr($languageFile, $defaultExtension) === false) {
+			$languageFile .= $defaultExtension;
+		}
+		if (file_exists($root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile)) {
+			require_once $root . 'language' . DIRECTORY_SEPARATOR . $xoopsConfig['language'] . DIRECTORY_SEPARATOR . $languageFile;
+		} else {    // Fallback
+			require_once $root . 'language' . DIRECTORY_SEPARATOR . 'english' . DIRECTORY_SEPARATOR . $languageFile;
+		}
+	}
+
+	/**
+	 * Création d'une vignette en tenant compte des options du module concernant le mode de création des vignettes
+	 *
+	 * @param  string  $src_path
+	 * @param  string  $dst_path
+	 * @param  integer $param_width
+	 * @param  integer $param_height
+	 * @param  boolean $keep_original
+	 * @param string   $fit Utilisé uniquement pour la méthode 0 (redimensionnement)
+	 * @return boolean
+	 */
+	public static function createThumb($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside')
+	{
+		//        require_once self::MODULE_PATH . 'class/wideimage/WideImage.php';
+		$resize = true;
+		// On commence par vérifier que l'image originale n'est pas plus petite que les dimensions demandées auquel cas il n'y a rien à faire
+		$pictureDimensions = getimagesize($src_path);
+		if (is_array($pictureDimensions)) {
+			$pictureWidth  = $pictureDimensions[0];
+			$pictureHeight = $pictureDimensions[1];
+			if ($pictureWidth < $param_width && $pictureHeight < $param_height) {
+				$resize = false;
+			}
+		}
+		$img = WideImage::load($src_path);
+		if ($resize) { // L'image est suffisament grande pour être réduite
+			$thumbMethod = 0;
+			if ($thumbMethod == 0) { // Redimensionnement de l'image
+				$result = $img->resize($param_width, $param_height, $fit);
+			} else { // Récupération d'une partie de l'image depuis le centre
+				// Calcul de left et top
+				$left = $top = 0;
+				if (is_array($pictureDimensions)) {
+					if ($pictureWidth > $param_width) {
+						$left = (int)(($pictureWidth / 2) - ($param_width / 2));
+					}
+					if ($pictureHeight > $param_height) {
+						$top = (int)(($pictureHeight / 2) - ($param_height / 2));
+					}
+				}
+				$result = $img->crop($left, $top, $param_width, $param_height);
+			}
+			$result->saveToFile($dst_path, null);
+		} else {
+			if ($src_path != $dst_path) {
+				@copy($src_path, $dst_path);
+			}
+		}
+		if (!$keep_original) {
+			@unlink($src_path);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Create the <option> of an html select
+	 *
+	 * @param  array $array   Array of index and labels
+	 * @param  mixed $default the default value
+	 * @param bool   $withNull
+	 * @return string
+	 */
+	private static function htmlSelectOptions($array, $default = 0, $withNull = true)
+	{
+		$ret      = array();
+		$selected = '';
+		if ($withNull) {
+			if (!is_array($default)) {
+				if ($default === 0) {
+					$selected = " selected = 'selected'";
+				}
+			} else {
+				if (in_array(0, $default)) {
+					$selected = " selected = 'selected'";
+				}
+			}
+			$ret[] = '<option value=0' . $selected . '>---</option>';
+		}
+
+		foreach ($array as $index => $label) {
+			$selected = '';
+			if (!is_array($default)) {
+				if ($index == $default) {
+					$selected = " selected = 'selected'";
+				}
+			} else {
+				if (in_array($index, $default)) {
+					$selected = " selected = 'selected'";
+				}
+			}
+			$ret[] = "<option value=\"" . $index . "\"" . $selected . '>' . $label . '</option>';
+		}
+
+		return implode("\n", $ret);
+	}
+
+	/**
+	 * Creates an html select an returns its code
+	 *
+	 * @param  string  $selectName Select's name
+	 * @param  array   $array      Key = value of each option, value = label of each option
+	 * @param  mixed   $default    Default's value
+	 * @param  boolean $withNull   Do we want a null option
+	 * @param  string  $style      Is there a style to apply ?
+	 * @param  boolean $multiple   Can we select multiple elements ?
+	 * @param  integer $size       Size of the selectbox, only used with multiple selectboxes
+	 * @param string   $extra
+	 * @return string
+	 */
+	public static function htmlSelect($selectName, $array, $default, $withNull = true, $style = '', $multiple = false, $size = 1, $extra = '')
+	{
+		$ret = '';
+		$ret .= "<select name='" . $selectName . "' id='" . $selectName . "'";
+		if (xoops_trim($style) != '') {
+			$ret .= " style='" . $style . "' ";
+		}
+		if (xoops_trim($multiple) != '') {
+			$ret .= " multiple = 'multiple' size='" . $size . "' ";
+		}
+		$ret .= $extra . ">\n";
+		$ret .= self::htmlSelectOptions($array, $default, $withNull);
+		$ret .= "</select>\n";
+
+		return $ret;
+	}
+
+	/**
+	 * Verify that a mysql table exists
+	 * @param $tablename
+	 * @return bool
+	 */
+	public static function tableExists($tablename)
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");
+
+		return ($xoopsDB->getRowsNum($result) > 0);
+	}
+
+	/**
+	 * Verify that a field exists inside a mysql table
+	 * @param $fieldname
+	 * @param $table
+	 * @return bool
+	 */
+	public static function fieldExists($fieldname, $table)
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
+
+		return ($xoopsDB->getRowsNum($result) > 0);
+	}
+
+	/**
+	 * Retourne la définition d'un champ
+	 *
+	 * @param  string $fieldname
+	 * @param  string $table
+	 * @return array
+	 */
+	public static function getFieldDefinition($fieldname, $table)
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
+		if ($result) {
+			return $xoopsDB->fetchArray($result);
+		}
+
+		return '';
+	}
+
+	/**
+	 * Add a field to a mysql table
+	 * @param $field
+	 * @param $table
+	 * @return resource
+	 */
+	public static function addField($field, $table)
+	{
+		global $xoopsDB;
+		$result = $xoopsDB->queryF("ALTER TABLE $table ADD $field;");
+
+		return $result;
+	}
+
+	/**
+	 * Maintenance des tables du module et de son cache de requêtes
+	 *
+	 * @return void
+	 */
+	public static function maintainTablesCache()
+	{
+		global $xoopsDB;
+		define('REFERENCES_MAINTAIN', true);
+		require self::MODULE_PATH . 'xoops_version.php';
+		$tables = array();
+		foreach ($modversion['tables'] as $table) {
+			$tables[] = $xoopsDB->prefix($table);
+		}
+		if (count($tables) > 0) {
+			$list = implode(',', $tables);
+			$xoopsDB->queryF('CHECK TABLE ' . $list);
+			$xoopsDB->queryF('ANALYZE TABLE ' . $list);
+			$xoopsDB->queryF('OPTIMIZE TABLE ' . $list);
+		}
+		self::updateCache();
+		$handlers = references_handler::getInstance();
+		$handlers->h_references_articles->forceCacheClean();
+	}
+
+	/**
+	 * Indique si le module Tag existe et est activé
+	 *
+	 * @return boolean
+	 * @credit: smartfactory
+	 */
+	public static function tagModuleExists()
+	{
+		static $moduleExistsAndIsActive;
+		if (!isset($moduleExistsAndIsActive)) {
+			$modules_handler = xoops_getHandler('module');
+			$tagModule       = $modules_handler->getByDirName('tag');
+			if (!$tagModule) {
+				$moduleExistsAndIsActive = false;
+			} else {
+				$moduleExistsAndIsActive = $tagModule->getVar('isactive') == 1;
+			}
+		}
+
+		return $moduleExistsAndIsActive;
+	}
 }

class/references_plugins.php

Indentation +236 added lines, -236 removed lines

@@ -25,266 +25,266 @@
  */
 class references_plugins
 {
-    /**
-     * Dictionnaire des évènements
-     */
-    const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
-    const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
+	/**
+	 * Dictionnaire des évènements
+	 */
+	const EVENT_ON_REFERENCE_CREATE = 'onReferenceCreate';
+	const EVENT_ON_CATEGORY_CREATE  = 'onCategoryCreate';
 
-    // Pour limiter les dépendances
-    const MODULE_DIRNAME = REFERENCES_DIRNAME;
+	// Pour limiter les dépendances
+	const MODULE_DIRNAME = REFERENCES_DIRNAME;
 
-    /**
-     * Types d'évènements
-     */
-    const PLUGIN_ACTION = 0;
-    const PLUGIN_FILTER = 1;
+	/**
+	 * Types d'évènements
+	 */
+	const PLUGIN_ACTION = 0;
+	const PLUGIN_FILTER = 1;
 
-    /**
-     * Nom du script Php inclut qui contient l'inscription des plugins
-     */
-    const PLUGIN_SCRIPT_NAME = 'plugins.php';
+	/**
+	 * Nom du script Php inclut qui contient l'inscription des plugins
+	 */
+	const PLUGIN_SCRIPT_NAME = 'plugins.php';
 
-    /**
-     * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
-     */
-    const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
+	/**
+	 * Dans le fichier Php qui contient l'inscription des plugins, méthode à appeler pour récupérer la liste des plugins
+	 */
+	const PLUGIN_DESCRIBE_METHOD = 'registerEvents';
 
-    /**
-     * Nom de la variable de session qui contient la liste des plugins détachés
-     */
-    const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
+	/**
+	 * Nom de la variable de session qui contient la liste des plugins détachés
+	 */
+	const PLUGIN_UNPLUG_SESSION_NAME = 'references_plugins';
 
-    /**
-     * Priorités des plugins
-     * @var constant
-     */
-    const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
-    const EVENT_PRIORITY_2 = 2;
-    const EVENT_PRIORITY_3 = 3;
-    const EVENT_PRIORITY_4 = 4;
-    const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
+	/**
+	 * Priorités des plugins
+	 * @var constant
+	 */
+	const EVENT_PRIORITY_1 = 1;    // Priorité la plus haute
+	const EVENT_PRIORITY_2 = 2;
+	const EVENT_PRIORITY_3 = 3;
+	const EVENT_PRIORITY_4 = 4;
+	const EVENT_PRIORITY_5 = 5;    // Priorité la plus basse
 
-    /**
-     * Utilisé pour construire le nom de la classe
-     */
-    private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
+	/**
+	 * Utilisé pour construire le nom de la classe
+	 */
+	private $pluginsTypeLabel = array(self::PLUGIN_ACTION => 'Action', self::PLUGIN_FILTER => 'Filter');
 
-    /**
-     * Nom des classes qu'il faut étendre en tant que plugin
-     */
-    private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
+	/**
+	 * Nom des classes qu'il faut étendre en tant que plugin
+	 */
+	private $pluginsClassName = array(self::PLUGIN_ACTION => 'references_action', self::PLUGIN_FILTER => 'references_filter');
 
-    /**
-     * Nom de chacun des dossiers en fonction du type de plugin
-     */
-    private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
+	/**
+	 * Nom de chacun des dossiers en fonction du type de plugin
+	 */
+	private $pluginsTypesFolder = array(self::PLUGIN_ACTION => 'actions', self::PLUGIN_FILTER => 'filters');
 
-    /**
-     * Contient l'unique instance de l'objet
-     * @var object
-     */
-    private static $instance = false;
+	/**
+	 * Contient l'unique instance de l'objet
+	 * @var object
+	 */
+	private static $instance = false;
 
-    /**
-     * Liste des évènements
-     * @var array
-     */
-    private static $events = array();
+	/**
+	 * Liste des évènements
+	 * @var array
+	 */
+	private static $events = array();
 
-    /**
-     * Retourne l'instance unique de la classe
-     *
-     * @return object
-     */
-    public static function getInstance()
-    {
-        static $instance;
-        if (null === $instance) {
-            $instance = new static();
-        }
+	/**
+	 * Retourne l'instance unique de la classe
+	 *
+	 * @return object
+	 */
+	public static function getInstance()
+	{
+		static $instance;
+		if (null === $instance) {
+			$instance = new static();
+		}
 
-        return $instance;
-    }
+		return $instance;
+	}
 
-    /**
-     * Chargement des 2 types de plugins
-     *
-     */
-    private function __construct()
-    {
-        $this->events = array();
-        $this->loadPlugins();
-    }
+	/**
+	 * Chargement des 2 types de plugins
+	 *
+	 */
+	private function __construct()
+	{
+		$this->events = array();
+		$this->loadPlugins();
+	}
 
-    /**
-     * Chargement des plugins (actions et filtres)
-     * @return void
-     */
-    public function loadPlugins()
-    {
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
-        $this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
-    }
+	/**
+	 * Chargement des plugins (actions et filtres)
+	 * @return void
+	 */
+	public function loadPlugins()
+	{
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_ACTION], self::PLUGIN_ACTION);
+		$this->loadPluginsFiles(REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[self::PLUGIN_FILTER], self::PLUGIN_FILTER);
+	}
 
-    /**
-     * Vérifie que le fichier Php passé en paramètre contient bien une classe de filtre ou d'action et si c'est le cas, le charge dans la liste des plugins
-     * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
-     * @param integer $type         Type de plugin recherché (action ou filtre)
-     * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
-     * @return void
-     */
-    private function loadClass($fullPathName, $type, $pluginFolder)
-    {
-        require_once $fullPathName;
-        // Du style referencesRegionalizationFilter
-        $className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
-        if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
-            // TODO: Vérifier que l'évènement n'est pas déjà en mémoire
-            $events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
-            foreach ($events as $event) {
-                $eventName                                         = $event[0];
-                $eventPriority                                     = $event[1];
-                $fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
-                $classToCall                                       = $event[3];
-                $methodToCall                                      = $event[4];
-                $this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
-            }
-        }
-    }
+	/**
+	 * Vérifie que le fichier Php passé en paramètre contient bien une classe de filtre ou d'action et si c'est le cas, le charge dans la liste des plugins
+	 * @param string  $fullPathName Chemin complet vers le fichier (répertoire + nom)
+	 * @param integer $type         Type de plugin recherché (action ou filtre)
+	 * @param string  $pluginFolder Le nom du répertoire dans lequel se trouve le fichier (le "dernier nom")
+	 * @return void
+	 */
+	private function loadClass($fullPathName, $type, $pluginFolder)
+	{
+		require_once $fullPathName;
+		// Du style referencesRegionalizationFilter
+		$className = self::MODULE_DIRNAME . ucfirst(strtolower($pluginFolder)) . $this->pluginsTypeLabel[$type];
+		if (class_exists($className) && get_parent_class($className) == $this->pluginsClassName[$type]) {
+			// TODO: Vérifier que l'évènement n'est pas déjà en mémoire
+			$events = call_user_func(array($className, self::PLUGIN_DESCRIBE_METHOD));
+			foreach ($events as $event) {
+				$eventName                                         = $event[0];
+				$eventPriority                                     = $event[1];
+				$fileToInclude                                     = REFERENCES_PLUGINS_PATH . $this->pluginsTypesFolder[$type] . DIRECTORY_SEPARATOR . $pluginFolder . DIRECTORY_SEPARATOR . $event[2];
+				$classToCall                                       = $event[3];
+				$methodToCall                                      = $event[4];
+				$this->events[$type][$eventName][$eventPriority][] = array('fullPathName' => $fileToInclude, 'className' => $classToCall, 'method' => $methodToCall);
+			}
+		}
+	}
 
-    /**
-     * Part à la recherche d'un type de plugin dans les répertoires
-     *
-     * @param  string $path La racine
-     * @param integer $type Le type de plugin recherché (action ou filtre)
-     * @return void
-     */
-    private function loadPluginsFiles($path, $type)
-    {
-        $objects = new DirectoryIterator($path);
-        foreach ($objects as $object) {
-            if ($object->isDir() && !$object->isDot()) {
-                $file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
-                if (file_exists($file)) {
-                    $this->loadClass($file, $type, $object->current());
-                }
-            }
-        }
-    }
+	/**
+	 * Part à la recherche d'un type de plugin dans les répertoires
+	 *
+	 * @param  string $path La racine
+	 * @param integer $type Le type de plugin recherché (action ou filtre)
+	 * @return void
+	 */
+	private function loadPluginsFiles($path, $type)
+	{
+		$objects = new DirectoryIterator($path);
+		foreach ($objects as $object) {
+			if ($object->isDir() && !$object->isDot()) {
+				$file = $path . DIRECTORY_SEPARATOR . $object->current() . DIRECTORY_SEPARATOR . self::PLUGIN_SCRIPT_NAME;
+				if (file_exists($file)) {
+					$this->loadClass($file, $type, $object->current());
+				}
+			}
+		}
+	}
 
-    /**
-     * Déclenchement d'une action et appel des plugins liés
-     *
-     * @param string                       $eventToFire L'action déclenchée
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
-     * @return object L'objet lui même pour chaîner
-     */
-    public function fireAction($eventToFire, references_parameters $parameters = null)
-    {
-        if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
+	/**
+	 * Déclenchement d'une action et appel des plugins liés
+	 *
+	 * @param string                       $eventToFire L'action déclenchée
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
+	 * @return object L'objet lui même pour chaîner
+	 */
+	public function fireAction($eventToFire, references_parameters $parameters = null)
+	{
+		if (!isset($this->events[self::PLUGIN_ACTION][$eventToFire])) {
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
 
-            return $this;
-        }
-        ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
-        foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
-            foreach ($events as $event) {
-                if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
-                    continue;
-                }
-                require_once $event['fullPathName'];
-                if (!class_exists($event['className'])) {
-                    $class = new $event['className'];
-                }
-                if (!method_exists($event['className'], $event['method'])) {
-                    continue;
-                }
-                call_user_func(array($event['className'], $event['method']), $parameters);
-                unset($class);
-            }
-        }
+			return $this;
+		}
+		ksort($this->events[self::PLUGIN_ACTION][$eventToFire]);    // Tri par priorit�
+		foreach ($this->events[self::PLUGIN_ACTION][$eventToFire] as $priority => $events) {
+			foreach ($events as $event) {
+				if ($this->isUnplug(self::PLUGIN_ACTION, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
+					continue;
+				}
+				require_once $event['fullPathName'];
+				if (!class_exists($event['className'])) {
+					$class = new $event['className'];
+				}
+				if (!method_exists($event['className'], $event['method'])) {
+					continue;
+				}
+				call_user_func(array($event['className'], $event['method']), $parameters);
+				unset($class);
+			}
+		}
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Déclenchement d'un filtre et appel des plugins liés
-     *
-     * @param string                       $eventToFire Le filtre appelé
-     * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
-     * @return object Le contenu de l'objet passé en paramètre
-     */
-    public function fireFilter($eventToFire, references_parameters $parameters)
-    {
-        if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
-            trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
+	/**
+	 * Déclenchement d'un filtre et appel des plugins liés
+	 *
+	 * @param string                       $eventToFire Le filtre appelé
+	 * @param object|references_parameters $parameters  Les paramètres à passer à chaque plugin
+	 * @return object Le contenu de l'objet passé en paramètre
+	 */
+	public function fireFilter($eventToFire, references_parameters $parameters)
+	{
+		if (!isset($this->events[self::PLUGIN_FILTER][$eventToFire])) {
+			trigger_error(sprintf(_MD_REFERENCES_PLUGINS_ERROR_1, $eventToFire));
 
-            return $this;
-        }
-        ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
-        foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
-            foreach ($events as $event) {
-                if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
-                    continue;
-                }
-                require_once $event['fullPathName'];
-                if (!method_exists($event['className'], $event['method'])) {
-                    continue;
-                }
-                //if (!class_exists($event['className'])) {
-                $class = new $event['className'];
-                //}
-                $class->$event['method']($parameters);
-                //call_user_func(array($event['className'], $event['method']), $parameters);
-                unset($class);
-            }
-        }
+			return $this;
+		}
+		ksort($this->events[self::PLUGIN_FILTER][$eventToFire]);    // Tri par priorité
+		foreach ($this->events[self::PLUGIN_FILTER][$eventToFire] as $priority => $events) {
+			foreach ($events as $event) {
+				if ($this->isUnplug(self::PLUGIN_FILTER, $eventToFire, $event['fullPathName'], $event['className'], $event['method'])) {
+					continue;
+				}
+				require_once $event['fullPathName'];
+				if (!method_exists($event['className'], $event['method'])) {
+					continue;
+				}
+				//if (!class_exists($event['className'])) {
+				$class = new $event['className'];
+				//}
+				$class->$event['method']($parameters);
+				//call_user_func(array($event['className'], $event['method']), $parameters);
+				unset($class);
+			}
+		}
 
-        if (!is_null($parameters)) {
-            return $parameters;
-        }
-    }
+		if (!is_null($parameters)) {
+			return $parameters;
+		}
+	}
 
-    /**
-     * Indique si un plugin s'est détaché d'un évènement particulier
-     *
-     * @param  integer $eventType
-     * @param  string  $eventToFire
-     * @param  string  $fullPathName
-     * @param  string  $className
-     * @param  string  $method
-     * @return boolean
-     */
-    public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
-    {
-        $unplug = array();
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
-        } else {
-            return false;
-        }
+	/**
+	 * Indique si un plugin s'est détaché d'un évènement particulier
+	 *
+	 * @param  integer $eventType
+	 * @param  string  $eventToFire
+	 * @param  string  $fullPathName
+	 * @param  string  $className
+	 * @param  string  $method
+	 * @return boolean
+	 */
+	public function isUnplug($eventType, $eventToFire, $fullPathName, $className, $method)
+	{
+		$unplug = array();
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
+		} else {
+			return false;
+		}
 
-        return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
-    }
+		return isset($unplug[$eventType][$eventToFire][$fullPathName][$className][$method]);
+	}
 
-    /**
-     * Permet à un plugin de se détacher d'un évènement
-     *
-     * @param  integer $eventType
-     * @param  string  $eventToFire
-     * @param  string  $fullPathName
-     * @param  string  $className
-     * @param  string  $method
-     * @return void
-     */
-    public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
-    {
-        $unplug = array();
-        if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
-            $unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
-        }
-        $unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
-        $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
-    }
+	/**
+	 * Permet à un plugin de se détacher d'un évènement
+	 *
+	 * @param  integer $eventType
+	 * @param  string  $eventToFire
+	 * @param  string  $fullPathName
+	 * @param  string  $className
+	 * @param  string  $method
+	 * @return void
+	 */
+	public function unplugFromEvent($eventType, $eventToFire, $fullPathName, $className, $method)
+	{
+		$unplug = array();
+		if (isset($_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME])) {
+			$unplug = $_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME];
+		}
+		$unplug[$eventType][$eventToFire][$fullPathName][$className][$method] = true;
+		$_SESSION[self::PLUGIN_UNPLUG_SESSION_NAME]                           = $unplug;
+	}
 }

class/lite.php

Indentation +836 added lines, -836 removed lines

@@ -28,840 +28,840 @@
 class references_Cache_Lite
 {
 
-    // --- Private properties ---
-
-    /**
-     * Directory where to put the cache files
-     * (make sure to add a trailing slash)
-     *
-     * @var string $_cacheDir
-     */
-    public $_cacheDir = '/tmp/';
-
-    /**
-     * Enable / disable caching
-     *
-     * (can be very usefull for the debug of cached scripts)
-     *
-     * @var boolean $_caching
-     */
-    public $_caching = true;
-
-    /**
-     * Cache lifetime (in seconds)
-     *
-     * If null, the cache is valid forever.
-     *
-     * @var int $_lifeTime
-     */
-    public $_lifeTime = 3600;
-
-    /**
-     * Enable / disable fileLocking
-     *
-     * (can avoid cache corruption under bad circumstances)
-     *
-     * @var boolean $_fileLocking
-     */
-    public $_fileLocking = true;
-
-    /**
-     * Timestamp of the last valid cache
-     *
-     * @var int $_refreshTime
-     */
-    public $_refreshTime;
-
-    /**
-     * File name (with path)
-     *
-     * @var string $_file
-     */
-    public $_file;
-
-    /**
-     * File name (without path)
-     *
-     * @var string $_fileName
-     */
-    public $_fileName;
-
-    /**
-     * Enable / disable write control (the cache is read just after writing to detect corrupt entries)
-     *
-     * Enable write control will lightly slow the cache writing but not the cache reading
-     * Write control can detect some corrupt cache files but maybe it's not a perfect control
-     *
-     * @var boolean $_writeControl
-     */
-    public $_writeControl = true;
-
-    /**
-     * Enable / disable read control
-     *
-     * If enabled, a control key is embeded in cache file and this key is compared with the one
-     * calculated after the reading.
-     *
-     * @var boolean $_writeControl
-     */
-    public $_readControl = true;
-
-    /**
-     * Type of read control (only if read control is enabled)
-     *
-     * Available values are :
-     * 'md5' for a md5 hash control (best but slowest)
-     * 'crc32' for a crc32 hash control (lightly less safe but faster, better choice)
-     * 'strlen' for a length only test (fastest)
-     *
-     * @var boolean $_readControlType
-     */
-    public $_readControlType = 'crc32';
-
-    /**
-     * Pear error mode (when raiseError is called)
-     *
-     * (see PEAR doc)
-     *
-     * @see setToDebug()
-     * @var int $_pearErrorMode
-     */
-    public $_pearErrorMode = REFERENCES_CACHE_LITE_ERROR_RETURN;
-
-    /**
-     * Current cache id
-     *
-     * @var string $_id
-     */
-    public $_id;
-
-    /**
-     * Current cache group
-     *
-     * @var string $_group
-     */
-    public $_group;
-
-    /**
-     * Enable / Disable "Memory Caching"
-     *
-     * NB : There is no lifetime for memory caching !
-     *
-     * @var boolean $_memoryCaching
-     */
-    public $_memoryCaching = false;
-
-    /**
-     * Enable / Disable "Only Memory Caching"
-     * (be carefull, memory caching is "beta quality")
-     *
-     * @var boolean $_onlyMemoryCaching
-     */
-    public $_onlyMemoryCaching = false;
-
-    /**
-     * Memory caching array
-     *
-     * @var array $_memoryCachingArray
-     */
-    public $_memoryCachingArray = array();
-
-    /**
-     * Memory caching counter
-     *
-     * @var int $memoryCachingCounter
-     */
-    public $_memoryCachingCounter = 0;
-
-    /**
-     * Memory caching limit
-     *
-     * @var int $memoryCachingLimit
-     */
-    public $_memoryCachingLimit = 1000;
-
-    /**
-     * File Name protection
-     *
-     * if set to true, you can use any cache id or group name
-     * if set to false, it can be faster but cache ids and group names
-     * will be used directly in cache file names so be carefull with
-     * special characters...
-     *
-     * @var boolean $fileNameProtection
-     */
-    public $_fileNameProtection = true;
-
-    /**
-     * Enable / disable automatic serialization
-     *
-     * it can be used to save directly datas which aren't strings
-     * (but it's slower)
-     *
-     * @var boolean $_serialize
-     */
-    public $_automaticSerialization = false;
-
-    /**
-     * Disable / Tune the automatic cleaning process
-     *
-     * The automatic cleaning process destroy too old (for the given life time)
-     * cache files when a new cache file is written.
-     * 0               => no automatic cache cleaning
-     * 1               => systematic cache cleaning
-     * x (integer) > 1 => automatic cleaning randomly 1 times on x cache write
-     *
-     * @var int $_automaticCleaning
-     */
-    public $_automaticCleaningFactor = 0;
-
-    /**
-     * Nested directory level
-     *
-     * Set the hashed directory structure level. 0 means "no hashed directory
-     * structure", 1 means "one level of directory", 2 means "two levels"...
-     * This option can speed up Cache_Lite only when you have many thousands of
-     * cache file. Only specific benchs can help you to choose the perfect value
-     * for you. Maybe, 1 or 2 is a good start.
-     *
-     * @var int $_hashedDirectoryLevel
-     */
-    public $_hashedDirectoryLevel = 0;
-
-    /**
-     * Umask for hashed directory structure
-     *
-     * @var int $_hashedDirectoryUmask
-     */
-    public $_hashedDirectoryUmask = 0700;
-
-    /**
-     * API break for error handling in REFERENCES_CACHE_LITE_ERROR_RETURN mode
-     *
-     * In REFERENCES_CACHE_LITE_ERROR_RETURN mode, error handling was not good because
-     * for example save() method always returned a boolean (a PEAR_Error object
-     * would be better in REFERENCES_CACHE_LITE_ERROR_RETURN mode). To correct this without
-     * breaking the API, this option (false by default) can change this handling.
-     *
-     * @var boolean
-     */
-    public $_errorHandlingAPIBreak = false;
-
-    // --- Public methods ---
-
-    /**
-     * Constructor
-     *
-     * $options is an assoc. Available options are :
-     * $options = array(
-     *     'cacheDir' => directory where to put the cache files (string) ,
-     *     'caching' => enable / disable caching (boolean) ,
-     *     'lifeTime' => cache lifetime in seconds (int) ,
-     *     'fileLocking' => enable / disable fileLocking (boolean) ,
-     *     'writeControl' => enable / disable write control (boolean) ,
-     *     'readControl' => enable / disable read control (boolean) ,
-     *     'readControlType' => type of read control 'crc32', 'md5', 'strlen' (string) ,
-     *     'pearErrorMode' => pear error mode (when raiseError is called) (cf PEAR doc) (int) ,
-     *     'memoryCaching' => enable / disable memory caching (boolean) ,
-     *     'onlyMemoryCaching' => enable / disable only memory caching (boolean) ,
-     *     'memoryCachingLimit' => max nbr of records to store into memory caching (int) ,
-     *     'fileNameProtection' => enable / disable automatic file name protection (boolean) ,
-     *     'automaticSerialization' => enable / disable automatic serialization (boolean) ,
-     *     'automaticCleaningFactor' => distable / tune automatic cleaning process (int) ,
-     *     'hashedDirectoryLevel' => level of the hashed directory system (int) ,
-     *     'hashedDirectoryUmask' => umask for hashed directory structure (int) ,
-     *     'errorHandlingAPIBreak' => API break for better error handling ? (boolean)
-     * );
-     *
-     * @param array $options options
-     * @access public
-     */
-    public function __construct($options = array(null))
-    {
-        foreach ($options as $key => $value) {
-            $this->setOption($key, $value);
-        }
-    }
-
-    /**
-     * Generic way to set a Cache_Lite option
-     *
-     * see Cache_Lite constructor for available options
-     *
-     * @var string $name  name of the option
-     * @var mixed  $value value of the option
-     * @access public
-     */
-    public function setOption($name, $value)
-    {
-        $availableOptions = array(
-            'errorHandlingAPIBreak',
-            'hashedDirectoryUmask',
-            'hashedDirectoryLevel',
-            'automaticCleaningFactor',
-            'automaticSerialization',
-            'fileNameProtection',
-            'memoryCaching',
-            'onlyMemoryCaching',
-            'memoryCachingLimit',
-            'cacheDir',
-            'caching',
-            'lifeTime',
-            'fileLocking',
-            'writeControl',
-            'readControl',
-            'readControlType',
-            'pearErrorMode'
-        );
-        if (in_array($name, $availableOptions)) {
-            $property        = '_' . $name;
-            $this->$property = $value;
-        }
-    }
-
-    /**
-     * Test if a cache is available and (if yes) return it
-     *
-     * @param string  $id                     cache id
-     * @param string  $group                  name of the cache group
-     * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
-     * @return string data of the cache (else : false)
-     * @access public
-     */
-    public function get($id, $group = 'default', $doNotTestCacheValidity = false)
-    {
-        $this->_id    = $id;
-        $this->_group = $group;
-        $data         = false;
-        if ($this->_caching) {
-            $this->_setRefreshTime();
-            $this->_setFileName($id, $group);
-            clearstatcache();
-            if ($this->_memoryCaching) {
-                if (isset($this->_memoryCachingArray[$this->_file])) {
-                    if ($this->_automaticSerialization) {
-                        return unserialize($this->_memoryCachingArray[$this->_file]);
-                    }
-
-                    return $this->_memoryCachingArray[$this->_file];
-                }
-                if ($this->_onlyMemoryCaching) {
-                    return false;
-                }
-            }
-            if ($doNotTestCacheValidity || is_null($this->_refreshTime)) {
-                if (file_exists($this->_file)) {
-                    $data = $this->_read();
-                }
-            } else {
-                if (file_exists($this->_file) && (@filemtime($this->_file) > $this->_refreshTime)) {
-                    $data = $this->_read();
-                }
-            }
-            if ($data && $this->_memoryCaching) {
-                $this->_memoryCacheAdd($data);
-            }
-            if ($this->_automaticSerialization && is_string($data)) {
-                $data = unserialize($data);
-            }
-
-            return $data;
-        }
-
-        return false;
-    }
-
-    /**
-     * Save some data in a cache file
-     *
-     * @param string $data  data to put in cache (can be another type than strings if automaticSerialization is on)
-     * @param string $id    cache id
-     * @param string $group name of the cache group
-     * @return boolean true if no problem (else : false or a PEAR_Error object)
-     * @access public
-     */
-    public function save($data, $id = null, $group = 'default')
-    {
-        if ($this->_caching) {
-            if ($this->_automaticSerialization) {
-                $data = serialize($data);
-            }
-            if (isset($id)) {
-                $this->_setFileName($id, $group);
-            }
-            if ($this->_memoryCaching) {
-                $this->_memoryCacheAdd($data);
-                if ($this->_onlyMemoryCaching) {
-                    return true;
-                }
-            }
-            if ($this->_automaticCleaningFactor > 0 && ($this->_automaticCleaningFactor == 1 || mt_rand(1, $this->_automaticCleaningFactor) == 1)) {
-                $this->clean(false, 'old');
-            }
-            if ($this->_writeControl) {
-                $res = $this->_writeAndControl($data);
-                if (is_bool($res)) {
-                    if ($res) {
-                        return true;
-                    }
-                    // if $res if false, we need to invalidate the cache
-                    @touch($this->_file, time() - 2 * abs($this->_lifeTime));
-
-                    return false;
-                }
-            } else {
-                $res = $this->_write($data);
-            }
-            if (is_object($res)) {
-                // $res is a PEAR_Error object
-                if (!$this->_errorHandlingAPIBreak) {
-                    return false; // we return false (old API)
-                }
-            }
-
-            return $res;
-        }
-
-        return false;
-    }
-
-    /**
-     * Remove a cache file
-     *
-     * @param string  $id                cache id
-     * @param string  $group             name of the cache group
-     * @param boolean $checkbeforeunlink check if file exists before removing it
-     * @return boolean true if no problem
-     * @access public
-     */
-    public function remove($id, $group = 'default', $checkbeforeunlink = false)
-    {
-        $this->_setFileName($id, $group);
-        if ($this->_memoryCaching) {
-            if (isset($this->_memoryCachingArray[$this->_file])) {
-                unset($this->_memoryCachingArray[$this->_file]);
-                --$this->_memoryCachingCounter;
-            }
-            if ($this->_onlyMemoryCaching) {
-                return true;
-            }
-        }
-        if ($checkbeforeunlink) {
-            if (!file_exists($this->_file)) {
-                return true;
-            }
-        }
-
-        return $this->_unlink($this->_file);
-    }
-
-    /**
-     * Clean the cache
-     *
-     * if no group is specified all cache files will be destroyed
-     * else only cache files of the specified group will be destroyed
-     *
-     * @param bool|string $group              name of the cache group
-     * @param string      $mode               flush cache mode : 'old', 'ingroup', 'notingroup',
-     *                                        'callback_myFunction'
-     * @return bool true if no problem
-     * @access public
-     */
-    public function clean($group = false, $mode = 'ingroup')
-    {
-        return $this->_cleanDir($this->_cacheDir, $group, $mode);
-    }
-
-    /**
-     * Set to debug mode
-     *
-     * When an error is found, the script will stop and the message will be displayed
-     * (in debug mode only).
-     *
-     * @access public
-     */
-    public function setToDebug()
-    {
-        $this->setOption('pearErrorMode', REFERENCES_CACHE_LITE_ERROR_DIE);
-    }
-
-    /**
-     * Set a new life time
-     *
-     * @param int $newLifeTime new life time (in seconds)
-     * @access public
-     */
-    public function setLifeTime($newLifeTime)
-    {
-        $this->_lifeTime = $newLifeTime;
-        $this->_setRefreshTime();
-    }
-
-    /**
-     * Save the state of the caching memory array into a cache file cache
-     *
-     * @param string $id    cache id
-     * @param string $group name of the cache group
-     * @access public
-     */
-    public function saveMemoryCachingState($id, $group = 'default')
-    {
-        if ($this->_caching) {
-            $array = array(
-                'counter' => $this->_memoryCachingCounter,
-                'array'   => $this->_memoryCachingArray
-            );
-            $data  = serialize($array);
-            $this->save($data, $id, $group);
-        }
-    }
-
-    /**
-     * Load the state of the caching memory array from a given cache file cache
-     *
-     * @param string  $id                     cache id
-     * @param string  $group                  name of the cache group
-     * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
-     * @access public
-     */
-    public function getMemoryCachingState($id, $group = 'default', $doNotTestCacheValidity = false)
-    {
-        if ($this->_caching) {
-            if ($data = $this->get($id, $group, $doNotTestCacheValidity)) {
-                $array                       = unserialize($data);
-                $this->_memoryCachingCounter = $array['counter'];
-                $this->_memoryCachingArray   = $array['array'];
-            }
-        }
-    }
-
-    /**
-     * Return the cache last modification time
-     *
-     * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY !
-     *
-     * @return int last modification time
-     */
-    public function lastModified()
-    {
-        return @filemtime($this->_file);
-    }
-
-    /**
-     * Trigger a PEAR error
-     *
-     * To improve performances, the PEAR.php file is included dynamically.
-     * The file is so included only when an error is triggered. So, in most
-     * cases, the file isn't included and perfs are much better.
-     *
-     * @param string $msg  error message
-     * @param int    $code error code
-     * @access public
-     * @return object
-     */
-    public function raiseError($msg, $code)
-    {
-        include_once('PEAR.php');
-
-        return references_PEAR::raiseError($msg, $code, $this->_pearErrorMode);
-    }
-
-    /**
-     * Extend the life of a valid cache file
-     *
-     * see http://pear.php.net/bugs/bug.php?id=6681
-     *
-     * @access public
-     */
-    public function extendLife()
-    {
-        @touch($this->_file);
-    }
-
-    // --- Private methods ---
-
-    /**
-     * Compute & set the refresh time
-     *
-     * @access private
-     */
-    public function _setRefreshTime()
-    {
-        if (is_null($this->_lifeTime)) {
-            $this->_refreshTime = null;
-        } else {
-            $this->_refreshTime = time() - $this->_lifeTime;
-        }
-    }
-
-    /**
-     * Remove a file
-     *
-     * @param string $file complete file path and name
-     * @return boolean true if no problem
-     * @access private
-     */
-    public function _unlink($file)
-    {
-        if (!@unlink($file)) {
-            return $this->raiseError('Cache_Lite : Unable to remove cache !', -3);
-        }
-
-        return true;
-    }
-
-    /**
-     * Recursive function for cleaning cache file in the given directory
-     *
-     * @param string      $dir   directory complete path (with a trailing slash)
-     * @param bool|string $group name of the cache group
-     * @param string      $mode  flush cache mode : 'old', 'ingroup', 'notingroup',
-     *                           'callback_myFunction'
-     * @return bool true if no problem
-     * @access private
-     */
-    public function _cleanDir($dir, $group = false, $mode = 'ingroup')
-    {
-        if ($this->_fileNameProtection) {
-            $motif = $group ? 'cache_' . md5($group) . '_' : 'cache_';
-        } else {
-            $motif = $group ? 'cache_' . $group . '_' : 'cache_';
-        }
-        if ($this->_memoryCaching) {
-            foreach ($this->_memoryCachingArray as $key => $v) {
-                if (strpos($key, $motif) !== false) {
-                    unset($this->_memoryCachingArray[$key]);
-                    --$this->_memoryCachingCounter;
-                }
-            }
-            if ($this->_onlyMemoryCaching) {
-                return true;
-            }
-        }
-        if (!($dh = opendir($dir))) {
-            return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
-        }
-        $result = true;
-        while ($file = readdir($dh)) {
-            if (($file !== '.') && ($file !== '..')) {
-                if (substr($file, 0, 6) === 'cache_') {
-                    $file2 = $dir . $file;
-                    if (is_file($file2)) {
-                        switch (substr($mode, 0, 9)) {
-                            case 'old':
-                                // files older than lifeTime get deleted from cache
-                                if (!is_null($this->_lifeTime)) {
-                                    if ((time() - @filemtime($file2)) > $this->_lifeTime) {
-                                        $result = ($result and $this->_unlink($file2));
-                                    }
-                                }
-                                break;
-                            case 'notingrou':
-                                if (strpos($file2, $motif) === false) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                            case 'callback_':
-                                $func = substr($mode, 9, strlen($mode) - 9);
-                                if ($func($file2, $group)) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                            case 'ingroup':
-                            default:
-                                if (strpos($file2, $motif) !== false) {
-                                    $result = ($result and $this->_unlink($file2));
-                                }
-                                break;
-                        }
-                    }
-                    if (is_dir($file2) and ($this->_hashedDirectoryLevel > 0)) {
-                        $result = ($result and $this->_cleanDir($file2 . '/', $group, $mode));
-                    }
-                }
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Add some date in the memory caching array
-     *
-     * @param string $data data to cache
-     * @access private
-     */
-    public function _memoryCacheAdd($data)
-    {
-        $this->_memoryCachingArray[$this->_file] = $data;
-        if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
-            list($key,) = each($this->_memoryCachingArray);
-            unset($this->_memoryCachingArray[$key]);
-        } else {
-            ++$this->_memoryCachingCounter;
-        }
-    }
-
-    /**
-     * Make a file name (with path)
-     *
-     * @param string $id    cache id
-     * @param string $group name of the group
-     * @access private
-     */
-    public function _setFileName($id, $group)
-    {
-        if ($this->_fileNameProtection) {
-            $suffix = 'cache_' . md5($group) . '_' . md5($id);
-        } else {
-            $suffix = 'cache_' . $group . '_' . $id;
-        }
-        $root = $this->_cacheDir;
-        if ($this->_hashedDirectoryLevel > 0) {
-            $hash = md5($suffix);
-            for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
-            }
-        }
-        $this->_fileName = $suffix;
-        $this->_file     = $root . $suffix;
-    }
-
-    /**
-     * Read the cache file and return the content
-     *
-     * @return string content of the cache file (else : false or a PEAR_Error object)
-     * @access private
-     */
-    public function _read()
-    {
-        $fp = @fopen($this->_file, 'rb');
-        if ($this->_fileLocking) {
-            @flock($fp, LOCK_SH);
-        }
-        if ($fp) {
-            clearstatcache();
-            $length = @filesize($this->_file);
-            //            $mqr = get_magic_quotes_runtime();
-            //            @set_magic_quotes_runtime(0);
-            if ($this->_readControl) {
-                $hashControl = @fread($fp, 32);
-                $length      = $length - 32;
-            }
-            if ($length) {
-                $data = @fread($fp, $length);
-            } else {
-                $data = '';
-            }
-            //            @set_magic_quotes_runtime($mqr);
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_UN);
-            }
-            @fclose($fp);
-            if ($this->_readControl) {
-                $hashData = $this->_hash($data, $this->_readControlType);
-                if ($hashData != $hashControl) {
-                    if (!is_null($this->_lifeTime)) {
-                        @touch($this->_file, time() - 2 * abs($this->_lifeTime));
-                    } else {
-                        @unlink($this->_file);
-                    }
-
-                    return false;
-                }
-            }
-
-            return $data;
-        }
-
-        return $this->raiseError('Cache_Lite : Unable to read cache !', -2);
-    }
-
-    /**
-     * Write the given data in the cache file
-     *
-     * @param string $data data to put in cache
-     * @return boolean true if ok (a PEAR_Error object else)
-     * @access private
-     */
-    public function _write($data)
-    {
-        if ($this->_hashedDirectoryLevel > 0) {
-            $hash = md5($this->_fileName);
-            $root = $this->_cacheDir;
-            for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
-                $root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
-                if (!(@is_dir($root))) {
-                    @mkdir($root, $this->_hashedDirectoryUmask);
-                }
-            }
-        }
-        $fp = @fopen($this->_file, 'wb');
-        if ($fp) {
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_EX);
-            }
-            if ($this->_readControl) {
-                @fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
-            }
-            //            $mqr = get_magic_quotes_runtime();
-            //            @set_magic_quotes_runtime(0);
-            @fwrite($fp, $data);
-            //            @set_magic_quotes_runtime($mqr);
-            if ($this->_fileLocking) {
-                @flock($fp, LOCK_UN);
-            }
-            @fclose($fp);
-
-            return true;
-        }
-
-        return $this->raiseError('Cache_Lite : Unable to write cache file : ' . $this->_file, -1);
-    }
-
-    /**
-     * Write the given data in the cache file and control it just after to avoir corrupted cache entries
-     *
-     * @param string $data data to put in cache
-     * @return boolean true if the test is ok (else : false or a PEAR_Error object)
-     * @access private
-     */
-    public function _writeAndControl($data)
-    {
-        $result = $this->_write($data);
-        if (is_object($result)) {
-            return $result; # We return the PEAR_Error object
-        }
-        $dataRead = $this->_read();
-        if (is_object($dataRead)) {
-            return $dataRead; # We return the PEAR_Error object
-        }
-        if (is_bool($dataRead) && (!$dataRead)) {
-            return false;
-        }
-
-        return ($dataRead == $data);
-    }
-
-    /**
-     * Make a control key with the string containing datas
-     *
-     * @param string $data        data
-     * @param string $controlType type of control 'md5', 'crc32' or 'strlen'
-     * @return string control key
-     * @access private
-     */
-    public function _hash($data, $controlType)
-    {
-        switch ($controlType) {
-            case 'md5':
-                return md5($data);
-            case 'crc32':
-                return sprintf('% 32d', crc32($data));
-            case 'strlen':
-                return sprintf('% 32d', strlen($data));
-            default:
-                return $this->raiseError('Unknown controlType ! (available values are only \'md5\', \'crc32\', \'strlen\')', -5);
-        }
-    }
+	// --- Private properties ---
+
+	/**
+	 * Directory where to put the cache files
+	 * (make sure to add a trailing slash)
+	 *
+	 * @var string $_cacheDir
+	 */
+	public $_cacheDir = '/tmp/';
+
+	/**
+	 * Enable / disable caching
+	 *
+	 * (can be very usefull for the debug of cached scripts)
+	 *
+	 * @var boolean $_caching
+	 */
+	public $_caching = true;
+
+	/**
+	 * Cache lifetime (in seconds)
+	 *
+	 * If null, the cache is valid forever.
+	 *
+	 * @var int $_lifeTime
+	 */
+	public $_lifeTime = 3600;
+
+	/**
+	 * Enable / disable fileLocking
+	 *
+	 * (can avoid cache corruption under bad circumstances)
+	 *
+	 * @var boolean $_fileLocking
+	 */
+	public $_fileLocking = true;
+
+	/**
+	 * Timestamp of the last valid cache
+	 *
+	 * @var int $_refreshTime
+	 */
+	public $_refreshTime;
+
+	/**
+	 * File name (with path)
+	 *
+	 * @var string $_file
+	 */
+	public $_file;
+
+	/**
+	 * File name (without path)
+	 *
+	 * @var string $_fileName
+	 */
+	public $_fileName;
+
+	/**
+	 * Enable / disable write control (the cache is read just after writing to detect corrupt entries)
+	 *
+	 * Enable write control will lightly slow the cache writing but not the cache reading
+	 * Write control can detect some corrupt cache files but maybe it's not a perfect control
+	 *
+	 * @var boolean $_writeControl
+	 */
+	public $_writeControl = true;
+
+	/**
+	 * Enable / disable read control
+	 *
+	 * If enabled, a control key is embeded in cache file and this key is compared with the one
+	 * calculated after the reading.
+	 *
+	 * @var boolean $_writeControl
+	 */
+	public $_readControl = true;
+
+	/**
+	 * Type of read control (only if read control is enabled)
+	 *
+	 * Available values are :
+	 * 'md5' for a md5 hash control (best but slowest)
+	 * 'crc32' for a crc32 hash control (lightly less safe but faster, better choice)
+	 * 'strlen' for a length only test (fastest)
+	 *
+	 * @var boolean $_readControlType
+	 */
+	public $_readControlType = 'crc32';
+
+	/**
+	 * Pear error mode (when raiseError is called)
+	 *
+	 * (see PEAR doc)
+	 *
+	 * @see setToDebug()
+	 * @var int $_pearErrorMode
+	 */
+	public $_pearErrorMode = REFERENCES_CACHE_LITE_ERROR_RETURN;
+
+	/**
+	 * Current cache id
+	 *
+	 * @var string $_id
+	 */
+	public $_id;
+
+	/**
+	 * Current cache group
+	 *
+	 * @var string $_group
+	 */
+	public $_group;
+
+	/**
+	 * Enable / Disable "Memory Caching"
+	 *
+	 * NB : There is no lifetime for memory caching !
+	 *
+	 * @var boolean $_memoryCaching
+	 */
+	public $_memoryCaching = false;
+
+	/**
+	 * Enable / Disable "Only Memory Caching"
+	 * (be carefull, memory caching is "beta quality")
+	 *
+	 * @var boolean $_onlyMemoryCaching
+	 */
+	public $_onlyMemoryCaching = false;
+
+	/**
+	 * Memory caching array
+	 *
+	 * @var array $_memoryCachingArray
+	 */
+	public $_memoryCachingArray = array();
+
+	/**
+	 * Memory caching counter
+	 *
+	 * @var int $memoryCachingCounter
+	 */
+	public $_memoryCachingCounter = 0;
+
+	/**
+	 * Memory caching limit
+	 *
+	 * @var int $memoryCachingLimit
+	 */
+	public $_memoryCachingLimit = 1000;
+
+	/**
+	 * File Name protection
+	 *
+	 * if set to true, you can use any cache id or group name
+	 * if set to false, it can be faster but cache ids and group names
+	 * will be used directly in cache file names so be carefull with
+	 * special characters...
+	 *
+	 * @var boolean $fileNameProtection
+	 */
+	public $_fileNameProtection = true;
+
+	/**
+	 * Enable / disable automatic serialization
+	 *
+	 * it can be used to save directly datas which aren't strings
+	 * (but it's slower)
+	 *
+	 * @var boolean $_serialize
+	 */
+	public $_automaticSerialization = false;
+
+	/**
+	 * Disable / Tune the automatic cleaning process
+	 *
+	 * The automatic cleaning process destroy too old (for the given life time)
+	 * cache files when a new cache file is written.
+	 * 0               => no automatic cache cleaning
+	 * 1               => systematic cache cleaning
+	 * x (integer) > 1 => automatic cleaning randomly 1 times on x cache write
+	 *
+	 * @var int $_automaticCleaning
+	 */
+	public $_automaticCleaningFactor = 0;
+
+	/**
+	 * Nested directory level
+	 *
+	 * Set the hashed directory structure level. 0 means "no hashed directory
+	 * structure", 1 means "one level of directory", 2 means "two levels"...
+	 * This option can speed up Cache_Lite only when you have many thousands of
+	 * cache file. Only specific benchs can help you to choose the perfect value
+	 * for you. Maybe, 1 or 2 is a good start.
+	 *
+	 * @var int $_hashedDirectoryLevel
+	 */
+	public $_hashedDirectoryLevel = 0;
+
+	/**
+	 * Umask for hashed directory structure
+	 *
+	 * @var int $_hashedDirectoryUmask
+	 */
+	public $_hashedDirectoryUmask = 0700;
+
+	/**
+	 * API break for error handling in REFERENCES_CACHE_LITE_ERROR_RETURN mode
+	 *
+	 * In REFERENCES_CACHE_LITE_ERROR_RETURN mode, error handling was not good because
+	 * for example save() method always returned a boolean (a PEAR_Error object
+	 * would be better in REFERENCES_CACHE_LITE_ERROR_RETURN mode). To correct this without
+	 * breaking the API, this option (false by default) can change this handling.
+	 *
+	 * @var boolean
+	 */
+	public $_errorHandlingAPIBreak = false;
+
+	// --- Public methods ---
+
+	/**
+	 * Constructor
+	 *
+	 * $options is an assoc. Available options are :
+	 * $options = array(
+	 *     'cacheDir' => directory where to put the cache files (string) ,
+	 *     'caching' => enable / disable caching (boolean) ,
+	 *     'lifeTime' => cache lifetime in seconds (int) ,
+	 *     'fileLocking' => enable / disable fileLocking (boolean) ,
+	 *     'writeControl' => enable / disable write control (boolean) ,
+	 *     'readControl' => enable / disable read control (boolean) ,
+	 *     'readControlType' => type of read control 'crc32', 'md5', 'strlen' (string) ,
+	 *     'pearErrorMode' => pear error mode (when raiseError is called) (cf PEAR doc) (int) ,
+	 *     'memoryCaching' => enable / disable memory caching (boolean) ,
+	 *     'onlyMemoryCaching' => enable / disable only memory caching (boolean) ,
+	 *     'memoryCachingLimit' => max nbr of records to store into memory caching (int) ,
+	 *     'fileNameProtection' => enable / disable automatic file name protection (boolean) ,
+	 *     'automaticSerialization' => enable / disable automatic serialization (boolean) ,
+	 *     'automaticCleaningFactor' => distable / tune automatic cleaning process (int) ,
+	 *     'hashedDirectoryLevel' => level of the hashed directory system (int) ,
+	 *     'hashedDirectoryUmask' => umask for hashed directory structure (int) ,
+	 *     'errorHandlingAPIBreak' => API break for better error handling ? (boolean)
+	 * );
+	 *
+	 * @param array $options options
+	 * @access public
+	 */
+	public function __construct($options = array(null))
+	{
+		foreach ($options as $key => $value) {
+			$this->setOption($key, $value);
+		}
+	}
+
+	/**
+	 * Generic way to set a Cache_Lite option
+	 *
+	 * see Cache_Lite constructor for available options
+	 *
+	 * @var string $name  name of the option
+	 * @var mixed  $value value of the option
+	 * @access public
+	 */
+	public function setOption($name, $value)
+	{
+		$availableOptions = array(
+			'errorHandlingAPIBreak',
+			'hashedDirectoryUmask',
+			'hashedDirectoryLevel',
+			'automaticCleaningFactor',
+			'automaticSerialization',
+			'fileNameProtection',
+			'memoryCaching',
+			'onlyMemoryCaching',
+			'memoryCachingLimit',
+			'cacheDir',
+			'caching',
+			'lifeTime',
+			'fileLocking',
+			'writeControl',
+			'readControl',
+			'readControlType',
+			'pearErrorMode'
+		);
+		if (in_array($name, $availableOptions)) {
+			$property        = '_' . $name;
+			$this->$property = $value;
+		}
+	}
+
+	/**
+	 * Test if a cache is available and (if yes) return it
+	 *
+	 * @param string  $id                     cache id
+	 * @param string  $group                  name of the cache group
+	 * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
+	 * @return string data of the cache (else : false)
+	 * @access public
+	 */
+	public function get($id, $group = 'default', $doNotTestCacheValidity = false)
+	{
+		$this->_id    = $id;
+		$this->_group = $group;
+		$data         = false;
+		if ($this->_caching) {
+			$this->_setRefreshTime();
+			$this->_setFileName($id, $group);
+			clearstatcache();
+			if ($this->_memoryCaching) {
+				if (isset($this->_memoryCachingArray[$this->_file])) {
+					if ($this->_automaticSerialization) {
+						return unserialize($this->_memoryCachingArray[$this->_file]);
+					}
+
+					return $this->_memoryCachingArray[$this->_file];
+				}
+				if ($this->_onlyMemoryCaching) {
+					return false;
+				}
+			}
+			if ($doNotTestCacheValidity || is_null($this->_refreshTime)) {
+				if (file_exists($this->_file)) {
+					$data = $this->_read();
+				}
+			} else {
+				if (file_exists($this->_file) && (@filemtime($this->_file) > $this->_refreshTime)) {
+					$data = $this->_read();
+				}
+			}
+			if ($data && $this->_memoryCaching) {
+				$this->_memoryCacheAdd($data);
+			}
+			if ($this->_automaticSerialization && is_string($data)) {
+				$data = unserialize($data);
+			}
+
+			return $data;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Save some data in a cache file
+	 *
+	 * @param string $data  data to put in cache (can be another type than strings if automaticSerialization is on)
+	 * @param string $id    cache id
+	 * @param string $group name of the cache group
+	 * @return boolean true if no problem (else : false or a PEAR_Error object)
+	 * @access public
+	 */
+	public function save($data, $id = null, $group = 'default')
+	{
+		if ($this->_caching) {
+			if ($this->_automaticSerialization) {
+				$data = serialize($data);
+			}
+			if (isset($id)) {
+				$this->_setFileName($id, $group);
+			}
+			if ($this->_memoryCaching) {
+				$this->_memoryCacheAdd($data);
+				if ($this->_onlyMemoryCaching) {
+					return true;
+				}
+			}
+			if ($this->_automaticCleaningFactor > 0 && ($this->_automaticCleaningFactor == 1 || mt_rand(1, $this->_automaticCleaningFactor) == 1)) {
+				$this->clean(false, 'old');
+			}
+			if ($this->_writeControl) {
+				$res = $this->_writeAndControl($data);
+				if (is_bool($res)) {
+					if ($res) {
+						return true;
+					}
+					// if $res if false, we need to invalidate the cache
+					@touch($this->_file, time() - 2 * abs($this->_lifeTime));
+
+					return false;
+				}
+			} else {
+				$res = $this->_write($data);
+			}
+			if (is_object($res)) {
+				// $res is a PEAR_Error object
+				if (!$this->_errorHandlingAPIBreak) {
+					return false; // we return false (old API)
+				}
+			}
+
+			return $res;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Remove a cache file
+	 *
+	 * @param string  $id                cache id
+	 * @param string  $group             name of the cache group
+	 * @param boolean $checkbeforeunlink check if file exists before removing it
+	 * @return boolean true if no problem
+	 * @access public
+	 */
+	public function remove($id, $group = 'default', $checkbeforeunlink = false)
+	{
+		$this->_setFileName($id, $group);
+		if ($this->_memoryCaching) {
+			if (isset($this->_memoryCachingArray[$this->_file])) {
+				unset($this->_memoryCachingArray[$this->_file]);
+				--$this->_memoryCachingCounter;
+			}
+			if ($this->_onlyMemoryCaching) {
+				return true;
+			}
+		}
+		if ($checkbeforeunlink) {
+			if (!file_exists($this->_file)) {
+				return true;
+			}
+		}
+
+		return $this->_unlink($this->_file);
+	}
+
+	/**
+	 * Clean the cache
+	 *
+	 * if no group is specified all cache files will be destroyed
+	 * else only cache files of the specified group will be destroyed
+	 *
+	 * @param bool|string $group              name of the cache group
+	 * @param string      $mode               flush cache mode : 'old', 'ingroup', 'notingroup',
+	 *                                        'callback_myFunction'
+	 * @return bool true if no problem
+	 * @access public
+	 */
+	public function clean($group = false, $mode = 'ingroup')
+	{
+		return $this->_cleanDir($this->_cacheDir, $group, $mode);
+	}
+
+	/**
+	 * Set to debug mode
+	 *
+	 * When an error is found, the script will stop and the message will be displayed
+	 * (in debug mode only).
+	 *
+	 * @access public
+	 */
+	public function setToDebug()
+	{
+		$this->setOption('pearErrorMode', REFERENCES_CACHE_LITE_ERROR_DIE);
+	}
+
+	/**
+	 * Set a new life time
+	 *
+	 * @param int $newLifeTime new life time (in seconds)
+	 * @access public
+	 */
+	public function setLifeTime($newLifeTime)
+	{
+		$this->_lifeTime = $newLifeTime;
+		$this->_setRefreshTime();
+	}
+
+	/**
+	 * Save the state of the caching memory array into a cache file cache
+	 *
+	 * @param string $id    cache id
+	 * @param string $group name of the cache group
+	 * @access public
+	 */
+	public function saveMemoryCachingState($id, $group = 'default')
+	{
+		if ($this->_caching) {
+			$array = array(
+				'counter' => $this->_memoryCachingCounter,
+				'array'   => $this->_memoryCachingArray
+			);
+			$data  = serialize($array);
+			$this->save($data, $id, $group);
+		}
+	}
+
+	/**
+	 * Load the state of the caching memory array from a given cache file cache
+	 *
+	 * @param string  $id                     cache id
+	 * @param string  $group                  name of the cache group
+	 * @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
+	 * @access public
+	 */
+	public function getMemoryCachingState($id, $group = 'default', $doNotTestCacheValidity = false)
+	{
+		if ($this->_caching) {
+			if ($data = $this->get($id, $group, $doNotTestCacheValidity)) {
+				$array                       = unserialize($data);
+				$this->_memoryCachingCounter = $array['counter'];
+				$this->_memoryCachingArray   = $array['array'];
+			}
+		}
+	}
+
+	/**
+	 * Return the cache last modification time
+	 *
+	 * BE CAREFUL : THIS METHOD IS FOR HACKING ONLY !
+	 *
+	 * @return int last modification time
+	 */
+	public function lastModified()
+	{
+		return @filemtime($this->_file);
+	}
+
+	/**
+	 * Trigger a PEAR error
+	 *
+	 * To improve performances, the PEAR.php file is included dynamically.
+	 * The file is so included only when an error is triggered. So, in most
+	 * cases, the file isn't included and perfs are much better.
+	 *
+	 * @param string $msg  error message
+	 * @param int    $code error code
+	 * @access public
+	 * @return object
+	 */
+	public function raiseError($msg, $code)
+	{
+		include_once('PEAR.php');
+
+		return references_PEAR::raiseError($msg, $code, $this->_pearErrorMode);
+	}
+
+	/**
+	 * Extend the life of a valid cache file
+	 *
+	 * see http://pear.php.net/bugs/bug.php?id=6681
+	 *
+	 * @access public
+	 */
+	public function extendLife()
+	{
+		@touch($this->_file);
+	}
+
+	// --- Private methods ---
+
+	/**
+	 * Compute & set the refresh time
+	 *
+	 * @access private
+	 */
+	public function _setRefreshTime()
+	{
+		if (is_null($this->_lifeTime)) {
+			$this->_refreshTime = null;
+		} else {
+			$this->_refreshTime = time() - $this->_lifeTime;
+		}
+	}
+
+	/**
+	 * Remove a file
+	 *
+	 * @param string $file complete file path and name
+	 * @return boolean true if no problem
+	 * @access private
+	 */
+	public function _unlink($file)
+	{
+		if (!@unlink($file)) {
+			return $this->raiseError('Cache_Lite : Unable to remove cache !', -3);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Recursive function for cleaning cache file in the given directory
+	 *
+	 * @param string      $dir   directory complete path (with a trailing slash)
+	 * @param bool|string $group name of the cache group
+	 * @param string      $mode  flush cache mode : 'old', 'ingroup', 'notingroup',
+	 *                           'callback_myFunction'
+	 * @return bool true if no problem
+	 * @access private
+	 */
+	public function _cleanDir($dir, $group = false, $mode = 'ingroup')
+	{
+		if ($this->_fileNameProtection) {
+			$motif = $group ? 'cache_' . md5($group) . '_' : 'cache_';
+		} else {
+			$motif = $group ? 'cache_' . $group . '_' : 'cache_';
+		}
+		if ($this->_memoryCaching) {
+			foreach ($this->_memoryCachingArray as $key => $v) {
+				if (strpos($key, $motif) !== false) {
+					unset($this->_memoryCachingArray[$key]);
+					--$this->_memoryCachingCounter;
+				}
+			}
+			if ($this->_onlyMemoryCaching) {
+				return true;
+			}
+		}
+		if (!($dh = opendir($dir))) {
+			return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
+		}
+		$result = true;
+		while ($file = readdir($dh)) {
+			if (($file !== '.') && ($file !== '..')) {
+				if (substr($file, 0, 6) === 'cache_') {
+					$file2 = $dir . $file;
+					if (is_file($file2)) {
+						switch (substr($mode, 0, 9)) {
+							case 'old':
+								// files older than lifeTime get deleted from cache
+								if (!is_null($this->_lifeTime)) {
+									if ((time() - @filemtime($file2)) > $this->_lifeTime) {
+										$result = ($result and $this->_unlink($file2));
+									}
+								}
+								break;
+							case 'notingrou':
+								if (strpos($file2, $motif) === false) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+							case 'callback_':
+								$func = substr($mode, 9, strlen($mode) - 9);
+								if ($func($file2, $group)) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+							case 'ingroup':
+							default:
+								if (strpos($file2, $motif) !== false) {
+									$result = ($result and $this->_unlink($file2));
+								}
+								break;
+						}
+					}
+					if (is_dir($file2) and ($this->_hashedDirectoryLevel > 0)) {
+						$result = ($result and $this->_cleanDir($file2 . '/', $group, $mode));
+					}
+				}
+			}
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Add some date in the memory caching array
+	 *
+	 * @param string $data data to cache
+	 * @access private
+	 */
+	public function _memoryCacheAdd($data)
+	{
+		$this->_memoryCachingArray[$this->_file] = $data;
+		if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
+			list($key,) = each($this->_memoryCachingArray);
+			unset($this->_memoryCachingArray[$key]);
+		} else {
+			++$this->_memoryCachingCounter;
+		}
+	}
+
+	/**
+	 * Make a file name (with path)
+	 *
+	 * @param string $id    cache id
+	 * @param string $group name of the group
+	 * @access private
+	 */
+	public function _setFileName($id, $group)
+	{
+		if ($this->_fileNameProtection) {
+			$suffix = 'cache_' . md5($group) . '_' . md5($id);
+		} else {
+			$suffix = 'cache_' . $group . '_' . $id;
+		}
+		$root = $this->_cacheDir;
+		if ($this->_hashedDirectoryLevel > 0) {
+			$hash = md5($suffix);
+			for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
+				$root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+			}
+		}
+		$this->_fileName = $suffix;
+		$this->_file     = $root . $suffix;
+	}
+
+	/**
+	 * Read the cache file and return the content
+	 *
+	 * @return string content of the cache file (else : false or a PEAR_Error object)
+	 * @access private
+	 */
+	public function _read()
+	{
+		$fp = @fopen($this->_file, 'rb');
+		if ($this->_fileLocking) {
+			@flock($fp, LOCK_SH);
+		}
+		if ($fp) {
+			clearstatcache();
+			$length = @filesize($this->_file);
+			//            $mqr = get_magic_quotes_runtime();
+			//            @set_magic_quotes_runtime(0);
+			if ($this->_readControl) {
+				$hashControl = @fread($fp, 32);
+				$length      = $length - 32;
+			}
+			if ($length) {
+				$data = @fread($fp, $length);
+			} else {
+				$data = '';
+			}
+			//            @set_magic_quotes_runtime($mqr);
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_UN);
+			}
+			@fclose($fp);
+			if ($this->_readControl) {
+				$hashData = $this->_hash($data, $this->_readControlType);
+				if ($hashData != $hashControl) {
+					if (!is_null($this->_lifeTime)) {
+						@touch($this->_file, time() - 2 * abs($this->_lifeTime));
+					} else {
+						@unlink($this->_file);
+					}
+
+					return false;
+				}
+			}
+
+			return $data;
+		}
+
+		return $this->raiseError('Cache_Lite : Unable to read cache !', -2);
+	}
+
+	/**
+	 * Write the given data in the cache file
+	 *
+	 * @param string $data data to put in cache
+	 * @return boolean true if ok (a PEAR_Error object else)
+	 * @access private
+	 */
+	public function _write($data)
+	{
+		if ($this->_hashedDirectoryLevel > 0) {
+			$hash = md5($this->_fileName);
+			$root = $this->_cacheDir;
+			for ($i = 0; $i < $this->_hashedDirectoryLevel; ++$i) {
+				$root = $root . 'cache_' . substr($hash, 0, $i + 1) . '/';
+				if (!(@is_dir($root))) {
+					@mkdir($root, $this->_hashedDirectoryUmask);
+				}
+			}
+		}
+		$fp = @fopen($this->_file, 'wb');
+		if ($fp) {
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_EX);
+			}
+			if ($this->_readControl) {
+				@fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
+			}
+			//            $mqr = get_magic_quotes_runtime();
+			//            @set_magic_quotes_runtime(0);
+			@fwrite($fp, $data);
+			//            @set_magic_quotes_runtime($mqr);
+			if ($this->_fileLocking) {
+				@flock($fp, LOCK_UN);
+			}
+			@fclose($fp);
+
+			return true;
+		}
+
+		return $this->raiseError('Cache_Lite : Unable to write cache file : ' . $this->_file, -1);
+	}
+
+	/**
+	 * Write the given data in the cache file and control it just after to avoir corrupted cache entries
+	 *
+	 * @param string $data data to put in cache
+	 * @return boolean true if the test is ok (else : false or a PEAR_Error object)
+	 * @access private
+	 */
+	public function _writeAndControl($data)
+	{
+		$result = $this->_write($data);
+		if (is_object($result)) {
+			return $result; # We return the PEAR_Error object
+		}
+		$dataRead = $this->_read();
+		if (is_object($dataRead)) {
+			return $dataRead; # We return the PEAR_Error object
+		}
+		if (is_bool($dataRead) && (!$dataRead)) {
+			return false;
+		}
+
+		return ($dataRead == $data);
+	}
+
+	/**
+	 * Make a control key with the string containing datas
+	 *
+	 * @param string $data        data
+	 * @param string $controlType type of control 'md5', 'crc32' or 'strlen'
+	 * @return string control key
+	 * @access private
+	 */
+	public function _hash($data, $controlType)
+	{
+		switch ($controlType) {
+			case 'md5':
+				return md5($data);
+			case 'crc32':
+				return sprintf('% 32d', crc32($data));
+			case 'strlen':
+				return sprintf('% 32d', strlen($data));
+			default:
+				return $this->raiseError('Unknown controlType ! (available values are only \'md5\', \'crc32\', \'strlen\')', -5);
+		}
+	}
 }