Enabled user selection of address format when adding from address book during message...

[squirrelmail.git] / functions / file_prefs.php

diff --git a/functions/file_prefs.php b/functions/file_prefs.php
index 93b47143d68ca02123f57f9fecfde73c63ce4800..028541f20b18e5ab15a2a55b3c6e895762dd0942 100644 (file)
--- a/functions/file_prefs.php
+++ b/functions/file_prefs.php
@@ -3,20 +3,22 @@
 /**
  * file_prefs.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This contains functions for manipulating user preferences in files
  *
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @subpackage prefs
+ * @since 1.2.5
  */
 
-/** include this for error messages */
-include_once(SM_PATH . 'functions/display_messages.php');
 
 /**
  * Check the preferences into the session cache.
+ * @param string $data_dir
+ * @param string $username
+ * @since 1.1.3
  */
 function cachePrefValues($data_dir, $username) {
     global $prefs_are_cached, $prefs_cache;
@@ -24,6 +26,8 @@ function cachePrefValues($data_dir, $username) {
     sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
     if ( isset($prefs_are_cached) && $prefs_are_cached) {
         sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
+//        sm_print_r($prefs_cache);
+//        exit;
         return;
     }
 
@@ -87,17 +91,22 @@ function cachePrefValues($data_dir, $username) {
 
 /**
  * Return the value for the preference given by $string.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $string preference name
+ * @param string $default (since 1.2.0) default preference value
+ * @return mixed
  */
 function getPref($data_dir, $username, $string, $default = '') {
     global $prefs_cache;
 
-    $result = do_hook_function('get_pref_override',array($username,$string));
+    $result = do_hook('get_pref_override', $temp=array(&$username, &$string));
     if (!$result) {
         cachePrefValues($data_dir, $username);
         if (isset($prefs_cache[$string])) {
             $result = $prefs_cache[$string];
         } else {
-            $result = do_hook_function('get_pref', array($username,$string));
+            $result = do_hook('get_pref', $temp=array(&$username, &$string));
             if (!$result) {
                 $result = $default;
             }
@@ -108,6 +117,9 @@ function getPref($data_dir, $username, $string, $default = '') {
 
 /**
  * Save the preferences for this user.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @since 1.1.3
  */
 function savePrefValues($data_dir, $username) {
     global $prefs_cache;
@@ -140,6 +152,9 @@ function savePrefValues($data_dir, $username) {
 
 /**
  * Remove a preference for the current user.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $string preference name
  */
 function removePref($data_dir, $username, $string) {
     global $prefs_cache;
@@ -155,6 +170,10 @@ function removePref($data_dir, $username, $string) {
 
 /**
  * Set a there preference $string to $value.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $string preference name
+ * @param mixed $value preference value
  */
 function setPref($data_dir, $username, $string, $value) {
     global $prefs_cache;
@@ -175,6 +194,10 @@ function setPref($data_dir, $username, $string, $value) {
 
 /**
  * Check for a preferences file. If one can not be found, create it.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param string $filename (since 1.2.0) preference file name.
+ *  detects file name, if set to empty string.
  */
 function checkForPrefs($data_dir, $username, $filename = '') {
     /* First, make sure we have the filename. */
@@ -217,9 +240,9 @@ function checkForPrefs($data_dir, $username, $filename = '') {
                 $uid = $user_data['name'];
             }
             $errTitle = _("Could not create initial preference file!");
-            $errString = $errTitle . "<br />\n" .
-                       sprintf( _("%s should be writable by user %s"), $data_dir, $uid ) . "<br />\n" .
-                       _("Please contact your system administrator and report this error.") . "<br />\n";
+            $errString = $errTitle . "\n" .
+                       sprintf( _("%s should be writable by user %s."), $data_dir, $uid ) . "\n" .
+                       _("Please contact your system administrator and report this error.") ;
             logout_error( $errString, $errTitle );
             exit;
         }
@@ -228,6 +251,11 @@ function checkForPrefs($data_dir, $username, $filename = '') {
 
 /**
  * Write the User Signature.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param integer $number (since 1.2.5) identity number.
+ *  parameter was used for signature text before 1.2.5.
+ * @param string $value (since 1.2.5) signature text
  */
 function setSig($data_dir, $username, $number, $value) {
     // Limit signature size to 64KB (database BLOB limit)
@@ -257,6 +285,10 @@ function setSig($data_dir, $username, $number, $value) {
 
 /**
  * Get the signature.
+ * @param string $data_dir data directory
+ * @param string $username user name
+ * @param integer $number (since 1.2.5) identity number
+ * @return string signature
  */
 function getSig($data_dir, $username, $number) {
     $filename = getHashedFile($username, $data_dir, "$username.si$number");
@@ -277,4 +309,3 @@ function getSig($data_dir, $username, $number) {
 }
 
 // vim: et ts=4
-?>
\ No newline at end of file