Stud.IP  5.4
Seminar_Auth Class Reference
Inheritance diagram for Seminar_Auth:
Seminar_Default_Auth Seminar_Register_Auth

Public Member Functions

 __construct ()
 
 check_feature ($f)
 
 start ()
 
 __sleep ()
 
 unauth ()
 
 logout ()
 
 login_if ($ok)
 
 is_authenticated ()
 
 auth_preauth ()
 
 auth_loginform ()
 
 auth_validatelogin ()
 
 auth_set_user_settings ($user)
 
 check_environment ()
 

Data Fields

 $classname
 
 $error_msg = ""
 
 $auth = []
 
 $need_email_activation = null
 

Protected Member Functions

 getState ()
 

Protected Attributes

 $persistent_slots = ["auth", "classname"]
 
 $nobody = false
 
 $cancel_login = "cancel_login"
 

Detailed Description

Seminar_Auth.class.php

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Author
André Noack noack.nosp@m.@dat.nosp@m.a-que.nosp@m.st.d.nosp@m.e

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Member Function Documentation

◆ __sleep()

__sleep ( )
Returns
array

◆ auth_loginform()

auth_loginform ( )

◆ auth_preauth()

auth_preauth ( )
Returns
bool

◆ auth_set_user_settings()

auth_set_user_settings (   $user)
Parameters
$user

◆ auth_validatelogin()

auth_validatelogin ( )
Returns
bool

◆ check_environment()

check_environment ( )

setup dummy user environment

◆ check_feature()

check_feature (   $f)
Parameters
$f
Returns
$this

◆ getState()

getState ( )
protected

Check current auth state. Should be one of 1) Not logged in (no valid auth info or auth expired) 2) Logged in (valid auth info) 3) Login in progress (if $this->cancel_login, revert to state 1)

Returns
int

◆ is_authenticated()

is_authenticated ( )
Returns
bool
Exceptions
AccessDeniedException

◆ login_if()

login_if (   $ok)
Parameters
$ok
Returns
bool

◆ logout()

logout ( )

◆ start()

start ( )
Returns
bool
Exceptions
RuntimeException

◆ unauth()

unauth ( )

Field Documentation

◆ $auth

$auth = []

◆ $cancel_login

$cancel_login = "cancel_login"
protected

◆ $classname

$classname

◆ $error_msg

$error_msg = ""

◆ $need_email_activation

$need_email_activation = null

◆ $nobody

$nobody = false
protected

◆ $persistent_slots

$persistent_slots = ["auth", "classname"]
protected

The documentation for this class was generated from the following file: