phpDocumentor updates

[squirrelmail.git] / functions / prefs.php

diff --git a/functions/prefs.php b/functions/prefs.php
index aaa12f0378b4ead34dcb38d4b72033c8c3d3c96f..6aab8d8d24b39f781c401c67e4e70a26f3ab390f 100644 (file)
--- a/functions/prefs.php
+++ b/functions/prefs.php
@@ -3,17 +3,21 @@
 /**
  * prefs.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This contains functions for manipulating user preferences
  *
+ * @copyright © 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @subpackage prefs
  */
 
+/** @ignore */
+if (!defined('SM_PATH')) define('SM_PATH','../');
+
 /** Include global.php */
 require_once(SM_PATH . 'functions/global.php');
+require_once(SM_PATH . 'functions/plugin.php');
 
 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
@@ -26,7 +30,8 @@ if ( !sqsession_is_registered('prefs_are_cached') ||
     $prefs_cache = array();
 }
 
-if (isset($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
+$prefs_backend = do_hook_function('prefs_backend');
+if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
     require_once(SM_PATH . $prefs_backend);
 } elseif (isset($prefs_dsn) && !empty($prefs_dsn)) {
     require_once(SM_PATH . 'functions/db_prefs.php');
@@ -41,13 +46,13 @@ if (isset($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
  * hashed location of that datafile.
  *
  * @param string username the username of the current user
- * @param string dir the squirrelmail datadir
+ * @param string dir the SquirrelMail datadir
  * @param string datafile the name of the file to open
  * @param bool hash_seach default true
  * @return string the hashed location of datafile
+ * @since 1.2.0
  */
 function getHashedFile($username, $dir, $datafile, $hash_search = true) {
-    global $dir_hash_level;
 
     /* Remove trailing slash from $dir if found */
     if (substr($dir, -1) == '/') {
@@ -92,9 +97,10 @@ function getHashedFile($username, $dir, $datafile, $hash_search = true) {
  * dir for that username.
  *
  * @param string username the username of the current user
- * @param string dir the squirrelmail datadir
+ * @param string dir the SquirrelMail datadir
  * @param string hash_dirs default ''
  * @return the path to the hash dir for username
+ * @since 1.2.0
  */
 function getHashedDir($username, $dir, $hash_dirs = '') {
     global $dir_hash_level;
@@ -132,6 +138,7 @@ function getHashedDir($username, $dir, $hash_dirs = '') {
  *
  * @param string username the username to calculate the hash dir for
  * @return array a list of hash dirs for this username
+ * @since 1.2.0
  */
 function computeHashDirs($username) {
     /* Compute the hash for this user and extract the hash directories. */
@@ -146,10 +153,12 @@ function computeHashDirs($username) {
 }
 
 /**
- * FIXME: Undocumented function
+ * Javascript support detection function
+ * @param boolean $reset recheck javascript support if set to true.
+ * @return integer SMPREF_JS_ON or SMPREF_JS_OFF ({@see functions/constants.php})
+ * @since 1.5.1
  */
-function checkForJavascript($reset = FALSE)
-{
+function checkForJavascript($reset = FALSE) {
   global $data_dir, $username, $javascript_on, $javascript_setting;
 
   if ( !$reset && sqGetGlobalVar('javascript_on', $javascript_on, SQ_SESSION) )