Class Gollem_Session

Description

Functions required to start a Gollem session.

$Horde: gollem/lib/Session.php,v 1.34.2.8 2009/01/06 15:23:54 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /lib/Session.php (line 17)


	
			
Method Summary
 void changeBackend (string $key)
 boolean createSession (string $key, [string $user = null], [string $pass = null], [array $args = array()])
Methods
changeBackend (line 196)

Change the currently active backend.

void changeBackend (string $key)
  • string $key: The ID of the backend to set as active.
createSession (line 57)

Take information posted from a login attempt and try setting up

an initial Gollem session. Handle Horde authentication, if required, and only do enough work to see if the user can log in. This function should only be called once, when the user first logs into Gollem.

Creates the $gollem session variable with the following entries: 'backend_key' -- The current backend 'be_list' -- The cached list of available backends 'selectlist' -- Stores file selections from the API call

Each backend is stored by its name in the 'backends' array. Each backend contains the following entries: 'attributes' -- See config/backends.php 'autologin' -- Whether this backend supports autologin 'clipboard' -- The clipboard for the current backend 'createhome' -- See config/backends.php 'dir' -- The current directory 'driver' -- See config/backends.php 'filter' -- See config/backends.php 'hasquota' -- Does VFS have quota support? 'home' -- The user's home directory 'hordeauth' -- See config/backends.php 'hostspec' -- See config/backends.php 'label' -- The label to use 'name' -- See config/backends.php 'params' -- See config/backends.php 'preferred' -- See config/backends.php 'root' -- The root directory

  • return: True on success, false on failure.
boolean createSession (string $key, [string $user = null], [string $pass = null], [array $args = array()])
  • string $key: The backend key to initialize.
  • string $user: The username to use for authentication.
  • string $pass: The password to use for authentication.
  • array $args: Any additional parameters the backend needs.

Documentation generated on Sun, 30 Jan 2011 05:24:45 +0000 by phpDocumentor 1.4.3