Class DAViCalSession

A class for creating and holding session information.

Session

DAViCalSession

Package: davical\DAViCalSession
Copyright: Catalyst .Net Ltd, Morphoss Ltd http://www.morphoss.com/
License: GNU GPL v2
Author: Andrew McMillan andrew@mcmillan.net.nz
Located at DAViCalSession.php

Methods summary
`public`	# `__construct( string $sid = '' )` Create a new DAViCalSession object. Create a new DAViCalSession object. We create a Session and extend it with some additional useful DAViCal related information. Parameters `$sid` A session identifier.
`public`	# `AssignSessionDetails( object $u )` Internal function used to assign the session details to a user's new session. Internal function used to assign the session details to a user's new session. Parameters `$u` The user+session object we (probably) read from the database.
`public`	# `GetRoles( )` Method used to get the user's roles Method used to get the user's roles
`public boolean`	# `HavePrivilegeTo( $do_what, $path, $any = null )` Does the user have the privileges to do what is requested. Does the user have the privileges to do what is requested. Parameters `$do_what` The request privilege name, or array of privilege names, to be checked. `$path` The path we want that permission for `$any` Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false. Returns boolean Whether they do have one of those privileges against the specified path.
`public boolean`	# `LoginRequired( string $roles = '' )` Checks that this user is logged in, and presents a login screen if they aren't. Checks that this user is logged in, and presents a login screen if they aren't. The function can optionally confirm whether they are a member of one of a list of roles, and deny access if they are not a member of any of them. Parameters `$roles` The list of roles that the user must be a member of one of to be allowed to proceed. Returns boolean Whether or not the user is logged in and is a member of one of the required roles.

Properties summary
`public`	`$principal_id`	#

Packages

Classes

Functions

Class DAViCalSession

Parameters

Parameters

Parameters

Returns

Parameters

Returns