/include/session.php

Description

Session constants and tools

Includes
require_once ('conf/config.php') (line 15)

General configuration file

Constants
DIR_REMOVE_ALL = 3 (line 28)

Recursive delete mode : Remove all

DIR_REMOVE_FILE = 1 (line 20)

Recursive delete mode : Remove only files (keep directory structure intact)

DIR_REMOVE_SUBDIR = 2 (line 24)

Recursive delete mode : Remove all except root directory

Functions
dir_size_recursive (line 180)

Get total size of files in a directory (recursively or not)

Note : Each file size is rounded up assuming default block size.

  • return: Cumulated size in bytes, 0 on error
integer dir_size_recursive (string $dir_name, [string $recur = true])
  • string $dir_name: Directory name (relative to site root)
  • string $recur: true to consider subdirectories, else false
get_browser_language (line 130)

Get language from browser language string (take preferred language)

  • return: Language ISO code : xx or xx-YY of preferred language or null if no language found
string get_browser_language (string $browser_language)
  • string $browser_language: Browser language string
plw_session_start (line 39)

Session start

Call instead of session_start() to start sessions. Cleanup temporary files ($GLOBALS['tmp_dir'] and $GLOBALS['upload_dir'] directories).

void plw_session_start ()
remove_dir_recursive (line 223)

Recursive delete a directory

Remove subdirs / dir only if all files in subdirs / dir are removed.

  • return: true if directory was removed, else false.
boolean remove_dir_recursive (string $dir_name, [integer $age = 0], [string $mode = DIR_REMOVE_SUBDIR], [integer $ts = null])
  • string $dir_name: Directory name (relative to site root)
  • integer $age: Remove only files modified more than <age> seconds ago (all if = 0)
  • string $mode: Delete mode (see DIR_REMOVE_*)
  • integer $ts: Current timestamp. Do not use, avoid calling time().
set_language (line 163)

Set language in session

void set_language (string $lang)
  • string $lang: Language to set (2 letters ISO code)
timer_start (line 283)

Start timer to measure performance

  • return: Unix timestamp in microseconds.
float timer_start ()
timer_stop (line 297)

Stop timer to measure performance

  • return: Elapsed real time in microseconds between timer_start() and timer_stop().
float timer_stop (float $start)
  • float $start: Timestamp returned by timer_start().

Documentation generated on Sat, 28 Mar 2009 23:17:11 +0000 by phpDocumentor 1.4.1