Sitellite Application Framework
Class Tree         Index         All Elements
You are here: SAF / Session / SessionHandler

Packages

Cache
Cart
CGI
Database
Date
Diff
File
Functions
GUI
HTML
I18n
Loader
Mail
MailForm
Misc
Parser
Security
Session
Site
Template
XML

Classes

Session
SessionAcl
SessionHandler
SessionHandler_Basic
SessionHandler_Cookie
SessionManager
SessionManager_Access
SessionManager_Pref
SessionManager_Resource
SessionManager_Role
SessionManager_Simple
SessionManager_Status
SessionManager_Team
SessionManager_User
SessionSource
SessionSource_Database
SessionStore
SessionStore_PHP

Files

Acl.php
Basic.php
Cookie.php
Database.php
Handler.php
Manager.php
PHP.php
Session.php
Source.php
Store.php

Class: SessionHandler

Source Location: Program_Root/Session/Handler/Handler.php

Class Overview




This is the base client handler package for saf.Session.  Custom  handlers are created by sub-classing this package.




Author(s)






        
              
      

Version


    
  
  • 1.0, 2002-10-10, $Id: Handler.php,v 1.2 2005/07/06 15:30:56 lux Exp $
    • 




Copyright


    
  
  • Copyright (C) 2001-2003, Simian Systems Inc.
    • 







Variables






Methods
















Child Classes






SessionHandler_Basic

	
Provides an HTTP Basic authentication client handler to the saf.Session  Package.






SessionHandler_Cookie

	
Provides a Cookie-based authentication client handler to the saf.Session  Package.









Inherited Variables





Inherited Methods














Class Details



[line 52]

This is the base client handler package for saf.Session.  Custom  handlers are created by sub-classing this package.


1     <?php
2     
3      $h = new SessionHandler;
4     
5      $h->setProperties (array (
6          'foo'    => 'bar',
7      ));
8     
9      $h->sendAuthRequest ();
10    
11     ? >





Tags:





  

    access:  public
  

  

    version:  1.0, 2002-10-10, $Id: Handler.php,v 1.2 2005/07/06 15:30:56 lux Exp $
  

  

    license:  http://www.sitellite.org/index/license
  

  

    copyright:  Copyright (C) 2001-2003, Simian Systems Inc.
  

  

    author:  John Luxford <mailto:lux@simian.ca>
  










[ Top ]







Class Variables



	
	

	
$error = 

	
[line 70]

  The error message if an error occurs.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$sessObj = 

	
[line 62]

  A reference to the main session object, in case it's  needed by a specific handler.





Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor SessionHandler [line 80]

	

    

    

		SessionHandler SessionHandler(
)
    

    


	
		Constructor method.





Tags:





  

    access:  public
  












        
[ Top ]

  

  

	
	
method changeTimeout [line 132]

	

    

    

		void changeTimeout(
integer
$newduration)
    

    


	
		Resets the client info with a new timeout value.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
SessionHandler_Cookie::changeTimeout()

		
Re-sends the session cookie with a new timeout value.

	

	




        
Parameters:

    

    

          

        integer  
        $newduration  
        
      

        

    


        
[ Top ]

  

  

	
	
method close [line 123]

	

    

    

		void close(
)
    

    


	
		Closes the session with the user.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
SessionHandler_Cookie::close()

		
Unsets the session cookie.

	

	




        
[ Top ]

  

  

	
	
method sendAuthRequest [line 114]

	

    

    

		void sendAuthRequest(
)
    

    


	
		Sends an authorization request to the user.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
SessionHandler_Basic::sendAuthRequest()

		
Sends the request for a username and password.

	

		

	
SessionHandler_Cookie::sendAuthRequest()

		
Sends the request for a username and password.  This would be  an HTML form in this case.

	

	




        
[ Top ]

  

  

	
	
method setProperties [line 90]

	

    

    

		void setProperties(
associative
$properties)
    

    


	
		Sets the properties of this object.





Tags:





  

    access:  public
  












        
Parameters:

    

    

          

        associative  
        $properties  
        array    $properties
      

        

    


        
[ Top ]

  

  

	
	
method start [line 105]

	

    

    

		boolean start(
string
$id, [boolean
$authorized = false])
    

    


	
		Initializes the communication with the client.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
SessionHandler_Basic::start()

		

	

		

	
SessionHandler_Cookie::start()

		
Initializes the communication with the client.  In the case  of this handler, if the $authorized value is true it sets the session  cookie with the $id value.

	

	




        
Parameters:

    

    

          

        string  
        $id  
        
      

          

        boolean  
        $authorized  
        
      

        

    


        
[ Top ]

  






      

    		
  




        

		    

		    Copyright © 2007, SIMIAN systems Inc.

		    All rights reserved.  Privacy policy

		    Documentation generated on Tue, 13 Feb 2007 17:17:42 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2