[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: federated_logon

Source Location: /zp-extensions/federated_logon.php

Class federated_logon

Method Summary
static void   alt_login_handler()   Provides a list of alternate handlers for logon
static void   buttons()   Creates a list of logon buttons for federated logon handlers.
static void   credentials()   Common logon handler.
static void   css()   Load the CSS for the logon buttons
static void   edit_admin()   Enter Admin user tab handler
static void   save_custom()   Check if an e-mail address has been provided
static string   verify()   Processes the verification POST tickets
federated_logon   __construct()   Option instantiation
void   getOptionsSupported()   Provides option list
void   handleOption()   Handles the custom option $option

[ Top ]
Methods
static method alt_login_handler  [line 168]

  static void alt_login_handler( $handler_list $handler_list  )

Provides a list of alternate handlers for logon

Parameters:
$handler_list   $handler_list: 


[ Top ]
static method buttons  [line 374]

  static void buttons( [ $redirect = NULL]  )

Creates a list of logon buttons for federated logon handlers.

Note that it will use an image if one exists. The name of the image should be cononical to the name of the logon handler, but without the "_logon'. The image must be a PNG file.

The styling of the buttons is done by the "federated_logon_buttons.css". If you do not like the one provided place an alternate version in your theme folder or the plugins/federated_logon folder.

Parameters:
   $redirect: 


[ Top ]
static method credentials  [line 193]

  static void credentials( $user $user, $email $email, $name $name, $redirect $redirect  )

Common logon handler.

Will log the user on if he exists. Otherwise it will create a user accoung and log on that account.

Redirects into Zenphoto on success presuming there is a redirect link.

Parameters:
$user   $user: 
$email   $email: 
$name   $name: 
$redirect   $redirect: 


[ Top ]
static method css  [line 151]

  static void css( )

Load the CSS for the logon buttons



[ Top ]
static method edit_admin  [line 294]

  static void edit_admin( $html $html, $userobj $userobj, $i $i, $background $background, $current $current, $local_alterrights $local_alterrights  )

Enter Admin user tab handler

Parameters:
$html   $html: 
$userobj   $userobj: 
$i   $i: 
$background   $background: 
$current   $current: 
$local_alterrights   $local_alterrights: 


[ Top ]
static method save_custom  [line 271]

  static void save_custom( $updated $updated, $userobj $userobj, $i $i, $alter $alter  )

Check if an e-mail address has been provided

Parameters:
$updated   $updated: 
$userobj   $userobj: 
$i   $i: 
$alter   $alter: 


[ Top ]
static method verify  [line 333]

  static string verify( string $script  )

Processes the verification POST tickets

Parameters:
string   $script:  (we do not use this)


[ Top ]
Constructor __construct  [line 74]

  federated_logon __construct( )

Option instantiation



[ Top ]
getOptionsSupported  [line 92]

  void getOptionsSupported( )

Provides option list



[ Top ]
handleOption  [line 144]

  void handleOption( $option $option, $currentValue $currentValue  )

Handles the custom option $option

Parameters:
$option   $option: 
$currentValue   $currentValue: 


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:29 +0200 by phpDocumentor 1.4.3