/functions/prefs.php

Description

prefs.php

This contains functions for filebased user prefs locations

Includes
include_once (SM_PATH.'functions/display_messages.php') (line 20)

include this for error messages

require_once (SM_PATH.'functions/global.php') (line 16)

Include global.php

require_once (SM_PATH.$prefs_backend) (line 37)
require_once (SM_PATH.'functions/file_prefs.php') (line 41)
require_once (SM_PATH.'functions/db_prefs.php') (line 39)
require_once (SM_PATH.'functions/plugin.php') (line 17)
Functions
computeHashDirs (line 146)

Helper function for getHashDir which does the actual hash calculation.

  • return: a list of hash dirs for this username
array computeHashDirs (string $username)
  • string $username: username the username to calculate the hash dir for
getHashedDir (line 109)

Helper function for getHashedFile(), given a username returns the hashed dir for that username.

NOTE that the hashed dir will be created if it doesn't already exist.

  • return: path to the hash dir for username
the getHashedDir (string $username, string $dir, [string $hash_dirs = ''])
  • string $username: username the username of the current user
  • string $dir: dir the squirrelmail datadir
  • string $hash_dirs: hash_dirs default ''
getHashedFile (line 56)

Given a username and datafilename, this will return the path to the hashed location of that datafile.

  • return: the hashed location of datafile
string getHashedFile (string $username, string $dir, string $datafile, [bool $hash_search = true])
  • string $username: username the username of the current user
  • string $dir: dir the squirrelmail datadir
  • string $datafile: datafile the name of the file to open
  • bool $hash_search: hash_seach default true

Documentation generated on Fri, 28 Nov 2014 04:21:39 +0100 by phpDocumentor 1.4.3