Class SampleAuthenticationBase

Description

Demonstrates the Tarîqa authentication mechanism

Located in /lib/SampleAuthenticationBase.class.php (line 8)

SampleBase
   |
   --SampleAuthenticationBase
Direct descendents
Class Description
ClusterList Demonstrates the access to Tarîqa list of clusters
CountryList Demonstrates the access to Tarîqa list of countries and continents
CountryStatisticsSample Demonstrates the access to Tarîqa Virage services
CreateLatestnewsFeed Demonstrates the access to Tariqa Create and Update Latestnews Feeds
CreateRSSFeed Demonstrates the access to Tariqa Create and Update RSS Feeds
CrisisCorrespondents Demonstrates the access to Tarîqa list of countries and continents
Delegations Demonstrates the access to Tarîqa list of countries and continents
EngineList Demonstrates the access to Tarîqa list of engines
FlavourList Demonstrates the access to Tarîqa list of flavours
GetBuzztracker Demonstrates the access to Buzztracker data
GetRSSFeed Demonstrates the access to RSS Feeds
GetURL Demonstrates the access to external web resources
GetURL2 Demonstrates the access to external web resources:
HotspotsList Demonstrates the access to Tariqa Hotspots countries
Indar Demonstrates the access to Tarîqa Indars
LatestNews Demonstrates the access to the LatestNews database
LatestnewsArticleList Demonstrates the access to Tariqa Latestnews Aggregator list of articles
LatestnewsFeedList Demonstrates the access to Tariqa Latestnews Aggregator list of feeds
LDAP Demonstrates access to the LDAP database
LexisNexis Demonstrates the Authentication machanism of LexisNexis's WSK
NewsletterSample Demonstrates the access to Tarîqa Newsletters
OxfordAnalytica Demonstrates the access to the OxfordAnalytica Data Provider
QueriesList Demonstrates the access to Tarîqa list of Queries
RSSArticleList Demonstrates the access to Tariqa RSS Aggregator list of articles
RSSFeedList Demonstrates the access to Tariqa RSS Aggregator list of feeds
SessionUserDetails Demonstrates the access to the personal details of authenticated users
SessionVariables Demonstrates the access to persistent variables and session variables
SMTP Demonstrates the access to persistent variables and session variables
SourcesList Demonstrates the access to Tarîqa list of sources
ThemesList Demonstrates the access to Tarîqa list of themes
VideoArchive Demonstrates the access to Tarîqa Indars
VirageDisplayDocumentImageSample Demonstrates the access to Tarîqa Virage services
VirageSample Demonstrates the access to Tarîqa Virage services
VirageSample2 Demonstrates the access to Tarîqa Virage services
WikipediaCountryProfile Demonstrates the access to external web resources:
Variable Summary
Method Summary
SampleAuthenticationBase __construct ()
void destroy ()
void displayLoginForm ([ $redirect = false])
void execute ()
void initialize ()
Variables
TariqaAuthenticationClient $auth_client = null (line 13)
  • var: The SOAP client object for authentication
  • access: protected
string $redirect = false (line 38)
  • var: URL where to redirect the browser after login (must be set by derived classes)
  • access: protected
string|false $token = false (line 18)
  • var: If false, indicates that the login was not successfull. Otherwise it will contain the Session Identifier string
  • access: protected
int $token_expires = false (line 23)
  • var: The expiration time (unix timestamp) of the Session Identifier
  • access: protected
boolean $token_https = null (line 28)
  • var: Flag indicating weither the authentication was made through HTTPS
  • access: protected
UserDetails $user_details = null (line 33)
  • var: The user details when logged in
  • access: protected

Inherited Variables

Inherited from SampleBase

SampleBase::$config
SampleBase::$descriptions
SampleBase::$display_code
SampleBase::$timing
SampleBase::$timing_names
SampleBase::$title
Methods
Constructor __construct (line 43)

Construct the object

  • access: public
SampleAuthenticationBase __construct ()

Redefinition of:
SampleBase::__construct()
Default constructor

Redefined in descendants as:
destroy (line 126)
  • access: public
void destroy ()

Redefinition of:
SampleBase::destroy()
Do some cleanup after execution.

Redefined in descendants as:
displayFarewellPage (line 205)

Display the farewell page to a logging-off user

  • access: protected
void displayFarewellPage ()
displayLoginForm (line 158)

Display a login form to the user

  • access: protected
void displayLoginForm ([ $redirect = false])
  • $redirect
displayWelcomePage (line 185)

Display the welcome page to an authenticated user

  • access: protected
void displayWelcomePage ()
execute (line 129)
  • access: public
void execute ()

Redefinition of:
SampleBase::execute()
Method that should contain the processing of the sample

Redefined in descendants as:
initialize (line 57)
  • access: public
void initialize ()

Redefinition of:
SampleBase::initialize()
Initialize the code.

Redefined in descendants as:

Inherited Methods

Inherited From SampleBase

SampleBase::__construct()
SampleBase::addTimeMark()
SampleBase::destroy()
SampleBase::execute()
SampleBase::htmlFoot()
SampleBase::htmlHead()
SampleBase::htmlMenu()
SampleBase::initialize()
SampleBase::printTimeMarks()
SampleBase::run()
Class Constants

Documentation generated on Mon, 30 Mar 2009 16:36:26 +0200 by phpDocumentor 1.4.1