Access Class Reference

List of all members.

Public Member Functions

 Access ()
 identify ()
 clear_authentication ($clear_sess=true)
 set_id ($id)
 get_id ()
 clear_id ($clear_sess=false)
 set_key ($key)
 set_keys ($keys)
 get_keys ($tree=false)
 serialize_keys ($keys)
 unserialize_keys ($keys)
 clear_keys ($clear_sess=false)
 has_access ($key)

Public Attributes

 $logged_in
 $access_id
 $access_keys

Detailed Description

PRONTO WEB FRAMEWORK Copyright (C) 2006, Judd Vinet

Author:
Judd Vinet <jvinet@zeroflux.org>

Description: Access control and User identification functions.

Definition at line 11 of file access.php.


Member Function Documentation

Access::Access (  ) 

Definition at line 17 of file access.php.

References clear_authentication(), and identify().

Access::clear_authentication ( clear_sess = true  ) 

Definition at line 32 of file access.php.

References clear_id().

Referenced by Access().

Access::clear_id ( clear_sess = false  ) 

Definition at line 51 of file access.php.

References clear_keys().

Referenced by clear_authentication().

Access::clear_keys ( clear_sess = false  ) 

Definition at line 160 of file access.php.

Referenced by clear_id().

Access::get_id (  ) 

Definition at line 46 of file access.php.

Access::get_keys ( tree = false  ) 

Return an array of all valid access keys. If ACCESS_MODEL is in "discrete" mode, then a pseudo-tree format will be used: group names are included, and keys are prefixed with "-- " to denote them as such.

Parameters:
$tree boolean Only relevant for the "discrete" model. If true, then a pseudo-tree format will be used: group names are included, and keys are prefixed with "-- " to denote them as such. This is useful for populating select/multiselect widgets to see which elements are groups/parents and which are keys/children.
Returns:
array

Definition at line 91 of file access.php.

References $GLOBALS.

Access::has_access ( key  ) 

Definition at line 166 of file access.php.

Access::identify (  ) 

Definition at line 23 of file access.php.

Referenced by Access().

Access::serialize_keys ( keys  ) 

Serialize an array of access keys into a CSV list suitable for DB storage

Parameters:
array $keys
Returns:
string

Definition at line 116 of file access.php.

References $GLOBALS, and $keys.

Access::set_id ( id  ) 

Definition at line 38 of file access.php.

Access::set_key ( key  ) 

Definition at line 59 of file access.php.

References $GLOBALS.

Referenced by set_keys().

Access::set_keys ( keys  ) 

Definition at line 73 of file access.php.

References $keys, and set_key().

Access::unserialize_keys ( keys  ) 

Unserialize a CSV list of access keys into an array so it can be used in a select/multiselect widget.

Parameters:
string $keys
Returns:
array

Definition at line 144 of file access.php.

References $keys.


Member Data Documentation

Access::$access_id

Definition at line 14 of file access.php.

Access::$access_keys

Definition at line 15 of file access.php.

Access::$logged_in

Definition at line 13 of file access.php.


The documentation for this class was generated from the following file:

Generated on Wed Jan 13 09:21:02 2010 for Pronto Framework by  doxygen 1.6.1