Class: Session

[line 164]
Session is a class that manages visitor sessions.

Note: Session does not handle anonymous sessions, but rather serves as a validation process for login-only site components. Session is relatively easy to integrate into web sites, but relies on a number of other Sitellite classes, such as Cookie, and CGI. It is also easy to extend in functionality, as we did with the SitelliteSession class by adding Sitellite CMS-specific permission functions.

Note: mt_srand() must also be called prior to creating a Session object, because the random number generator must be seeded.

New in 2.0:

• This is a complete rewrite that breaks backward compatibility with 1.x. It offers an abstracted Session class that uses drivers for both the validation source and the visitor protocol handler. Initially, there is only one source driver, which is a database driver, and there are two handler drivers, one for storing session ids using cookies and the other challenges the client with an HTTP Basic authentication request.

New in 2.2:

• $store (store driver object)
• $autoSave (whether to call save() after each call to set())
• setStoreProperties ()
• get ()
• set ()
• append()
• save ()

New in 2.4:

• Added session_get(), session_set(), session_append(), and session_save() global functions that simply call the equivalent methods on a global $session object.

New in 3.0:

• Added the use of a new SessionAcl package which provides access control functionality to this package, meant to serve as a replacement for the SitelliteSession overriding package. SessionAcl adds finer granularity in defining and controlling users through the separation of read and write access, and also boasts a new INI-based definition format in place of the MySQL sitellite_role, sitellite_team, sitellite_access, and sitellite_status tables. This will not only improve flexibility, but it should also make this package significantly faster too.
• Broke backward compatibility in the parameters of the allowed() method. As compared to the SitelliteSession package, this also eliminates the getPermissions() method, which is replaced by internal handling of this functionality.

Historical ----------

New in 1.2:

• Updated to use $site->webpath instead of $site->path, which is deprecated in saf.Site.

New in 1.4:

• Added the ability to make accounts pending, so that they must be verified via email. This is done by storing a 24 character random string, preceded by 'PENDING:' in the $sidcol column. This key string can be generated with the new makePendingKey() method.

New in 1.6:

• Traded $tpl->fill() calls for sprintf(), which should increase performance a little.
• Moved the encryption of the password field into the PHP level, so as to eliminate the reliance on MySQL-specific functions (ie. password()). Unfortunately, this breaks backward compatibility and all passwords will need to be reset, since both MySQL's password() and PHP's crypt() are one-way encryption methods.

New in 1.8:

• Added the following methods as aliases of properties or methods of a global $session object: session_username(), session_valid(), session_get(), session_set(), session_append(), and session_save().

1     <?php
2     
3      // seed the "better" random number generator
4      mt_srand ((double) microtime () * 1000000);
5     
6      $sessionCookieName = 'cisforcookie';
7      $sessionHandler = 'Cookie';
8      $sessionSource = 'Database';
9     
10     list ($user, $pass, $id) = Session::gatherParameters ($sessionHandler, $sessionCookieName);
11    
12     $session = new Session ($sessionHandler, $sessionSource, $user, $pass, $id);
13    
14     // time out in 1 hour
15     $session->setTimeout (3600);
16    
17     $session->setSourceProperties (array (
18         'database' => 'db',
19     ));
20    
21     $session->setHandlerProperties (array (
22         'cookiename' => 'cisforcookie',
23         'cookiedomain' => 'www.yourwebsite.com',
24         'cookiepath' => '/',
25     ));
26    
27     $session->start ();
28    
29     if ($session->error) {
30         // something is not right
31         echo $session->error;
32    
33     } elseif ($session->valid) {
34         // valid session
35         // put all of your private stuff here
36    
37     } else {
38         // invalid or new session
39         $session->sendAuthRequest ();
40    
41     }
42    
43     ? >

Tags:

$autoSave =  true

[line 237]

Specifies whether calls to set() should also call save() automatically. Defaults to true, since for most intents and purposes this is a nice way of not having to think about it.

Tags:

$error =  false

[line 191]

Contains the error message if any error occurs within this class, the handler or the source drivers, or false if no error has occurred.

Tags:

$handler =

[line 245]

The handler driver object.

Tags:

$id =

[line 173]

The session id value.

Tags:

$password =

[line 207]

Contains the password of the user.

Tags:

$source =

[line 253]

The source driver object.

Tags:

$store =

[line 261]

The store driver object.

Tags:

$timeout =  3600

[line 227]

Specifies a length in seconds that the session may be inactive for before automatically logging the user out. This is also optional, as some handlers or sources may not support it.

Tags:

$useID =  true

[line 217]

Specifies whether or not to use a session id. Some handlers or sources may not support session ids (ie. the Basic handler), and so they may be disabled.

Tags:

$username =

[line 199]

Contains the username of the user.

Tags:

$valid =  false

[line 181]

Says whether this session is valid.

Tags:

---

constructor Session [line 277]

---

method allowed [line 667]

---

method allowedSql [line 679]

---

method append [line 617]

---

method authorize [line 392]

---

method close [line 561]

---

method gatherParameters [line 524]

---

method get [line 579]

---

method getManager [line 763]

---

method getUser [line 740]

---

method getUserByEmail [line 754]

---

method init [line 321]

---

method isValidKey [line 707]

---

method makePendingKey [line 543]

---

method makeRecoverKey [line 691]

---

method save [line 645]

---

method sendAuthRequest [line 502]

---

method set [line 596]

---

method setHandlerProperties [line 368]

---

method setSourceProperties [line 357]

---

method setStoreProperties [line 379]

---

method setTimeout [line 346]

---

method start [line 417]

---

method update [line 719]