Class Horde_Kolab_FreeBusy_Access

Description

The Horde_Kolab_FreeBusy_Access:: class provides functionality to check free/busy access rights for the specified folder.

$Horde: framework/Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Access.php,v 1.15.2.4 2010/06/25 08:08:29 wrobel Exp $

Copyright 2004-2008 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Access.php (line 31)


	
			
Variable Summary
 string $cn
 string $folder
 string $imap_folder
 string $owner
 string $owner_object
 string $user
 string $user_object
 boolean $_authenticated
 string $_auth_error
Method Summary
 Horde_Kolab_FreeBusy_Access Horde_Kolab_FreeBusy_Access (array $params)
 boolean|PEAR_Error authenticated ()
 void fetchRemote ([boolean $trigger = false], [boolean $extended = false])
 boolean|PEAR_Error parseFolder ([string $req_folder = ''])
 boolean|PEAR_Error parseOwner ([string $owner = ''])
 string _getImapFolder ()
 void _parseUser ()
 boolean|PEAR_Error _process ()
Variables
string $cn = '' (line 101)

The common name (CN) of the owner.

string $folder (line 87)

The folder we try to access.

string $freebusyserver (line 108)

The free/busy server for the folder owner.

string $imap_folder (line 94)

The IMAP path of folder we try to access.

string $owner (line 66)

The requested owner.

string $owner_object (line 73)

The object representing the folder owner.

string $server_object (line 80)

The object representing the server configuration.

string $user (line 38)

The user calling the script.

string $user_object (line 59)

The object representing the user calling the script.

boolean $_authenticated = false (line 45)

Did the above combination authenticate?

string $_auth_error (line 52)

Contains an error string if authentication failed.

Methods
Constructor Horde_Kolab_FreeBusy_Access (line 115)

Constructor.

Horde_Kolab_FreeBusy_Access Horde_Kolab_FreeBusy_Access (array $params)
  • array $params: Any additional options
authenticated (line 227)

Check if we are in an authenticated situation.

  • return: True if successful.
boolean|PEAR_Error authenticated ()
fetchRemote (line 177)

Fetch remote free/busy user if the current user is not local or redirect to the other server if configured this way.

void fetchRemote ([boolean $trigger = false], [boolean $extended = false])
  • boolean $trigger: Have we been called for triggering?
  • boolean $extended: Should the extended information been delivered?
parseFolder (line 127)

Parse the requested folder for the owner of that folder.

  • return: True if successful.
boolean|PEAR_Error parseFolder ([string $req_folder = ''])
  • string $req_folder: The folder requested.
parseOwner (line 159)

Parse the owner value.

  • return: True if successful.
boolean|PEAR_Error parseOwner ([string $owner = ''])
  • string $owner: The owner that should be processed.
_getImapFolder (line 415)

Calculate the correct IMAP folder name to access based on the combination of user and owner.

  • return: The IMAP folder we should access.
string _getImapFolder ()
_parseUser (line 247)

Parse the current user accessing the page and try to authenticate the user.

void _parseUser ()
_process (line 323)

Process both the user accessing the page as well as the owner of the requested free/busy information.

  • return: True if successful.
boolean|PEAR_Error _process ()

Documentation generated on Sun, 30 Jan 2011 05:14:56 +0000 by phpDocumentor 1.4.3