Transaction Engine 3 Application Programming Interface
[ class tree: Transaction Engine 3 Application Programming Interface ] [ index: Transaction Engine 3 Application Programming Interface ] [ all elements ]

Class: tNG_Logout

Source Location: /tNG3/triggers/tNG_Logout.class.php

Class Overview


the class that handle the logout of the user;


Author(s):

Variables

Methods



Class Details

[line 9]
the class that handle the logout of the user;



Tags:

access:  public


[ Top ]


Class Variables

$logoutType =  'load'

[line 15]

logoutType default value: load



Tags:

access:  public

Type:   string


[ Top ]

$pageRedirect =  ""

[line 21]

redirect to page:



Tags:

access:  public

Type:   striung


[ Top ]



Class Methods


method Execute [line 75]

nothing Execute( )

Main method of the class. Execute the code; Make the redirect



Tags:

access:  public


[ Top ]

method getLogoutLink [line 100]

string getLogoutLink( )

getter. get the url for logout



Tags:

access:  public


[ Top ]

method setLogoutType [line 27]

void setLogoutType( [string $logoutType = 'load'])

setter.



Tags:

access:  public


Parameters:

string   $logoutType   logoutType

[ Top ]

method setPageRedirect [line 35]

void setPageRedirect( string $pageRedirect)

setter. set tha page url where the user is redirect after log out



Tags:

access:  public


Parameters:

string   $pageRedirect   pageRedirect

[ Top ]

method unsetAll [line 43]

nothing unsetAll( )

Unset the session variables that have to do with user login;



Tags:

access:  public


[ Top ]



Documentation generated on Tue, 6 Dec 2005 15:11:49 +0200 by phpDocumentor 1.3.0RC3