Inheritance diagram for ilPDOAuthentication:

Collaboration diagram for ilPDOAuthentication:

Public Member Functions
	__construct ()

	setIdle ($time, $add=false)
	Set maximum idle time. More...

	setExpire ($time, $add=false)
	Set the maximum expire time. More...

	start ()
	Start new auth session. More...

	getAuth ()
	Has the user been authenticated? More...

	getStatus ()

	getUsername ()

	sessionValidThru ()
	Returns the time up to the session is valid. More...

	logout ()

Protected Member Functions
	checkAuth ()

	login ()

	assignData ()

Protected Attributes
	$_sessionName = '_authsession'

	$allowLogin = true

	$_postUsername = 'username'

	$_postPassword = 'password'

	$advancedsecurity

	$enableLogging

	$regenerateSessionId

	$status = ''

	$username = null

	$password

	$session

	$server

	$post

	$cookie

Private Member Functions
	setAuth ($username)

Detailed Description

Definition at line 8 of file class.ilPDOAuthentication.php.

Constructor & Destructor Documentation

◆ __construct()

ilPDOAuthentication::__construct ( )

Definition at line 26 of file class.ilPDOAuthentication.php.

References $_COOKIE, $_POST, $_SERVER, $_SESSION, and $_sessionName.

     {
         //        $started = session_start();
         //        $sess = session_id();
         //        $db_session_handler = new ilSessionDBHandler();
         //        if (!$db_session_handler->setSaveHandler())
         //        {
         //            throw new Exception("Disable save mode or set session_hanlder to \"user\"");
         //        }
         @session_start(); // Due to UnitTests we have to silence this...
 
         $this->session = $_SESSION[$this->_sessionName];
         $this->server = $_SERVER;
         $this->post = $_POST;
         $this->cookie = $_COOKIE;
     }

Member Function Documentation

◆ assignData()

ilPDOAuthentication::assignData ( )

protected

Definition at line 144 of file class.ilPDOAuthentication.php.

References $_postPassword, and $_postUsername.

Referenced by start().

     {
         if (isset($this->post[$this->_postUsername])
             && $this->post[$this->_postUsername] != ''
         ) {
             $this->username = (get_magic_quotes_gpc() == 1 ? stripslashes($this->post[$this->_postUsername]) : $this->post[$this->_postUsername]);
         }
         if (isset($this->post[$this->_postPassword])
             && $this->post[$this->_postPassword] != ''
         ) {
             $this->password = (get_magic_quotes_gpc() == 1 ? stripslashes($this->post[$this->_postPassword]) : $this->post[$this->_postPassword]);
         }
     }

Here is the caller graph for this function:

◆ checkAuth()

ilPDOAuthentication::checkAuth ( )

protected

Returns: bool

Definition at line 79 of file class.ilPDOAuthentication.php.

References $_SESSION.

Referenced by getAuth(), and start().

     {
         return isset($_SESSION['_authsession']['username']);
     }

Here is the caller graph for this function:

◆ getAuth()

ilPDOAuthentication::getAuth ( )

Has the user been authenticated?

Is there a valid login session. Previously this was different from checkAuth() but now it is just an alias.

Returns: bool True if the user is logged in, otherwise false.

Implements ilAuthPDOInterface.

Definition at line 103 of file class.ilPDOAuthentication.php.

References checkAuth().

     {
         return $this->checkAuth();
     }

Here is the call graph for this function:

◆ getStatus()

ilPDOAuthentication::getStatus ( )

Returns: string

Implements ilAuthPDOInterface.

Definition at line 112 of file class.ilPDOAuthentication.php.

References $status.

     {
         return $this->status;
     }

◆ getUsername()

ilPDOAuthentication::getUsername ( )

Returns: string

Implements ilAuthPDOInterface.

Definition at line 121 of file class.ilPDOAuthentication.php.

References $_SESSION.

     {
         return $_SESSION['_authsession']['username'];
     }

◆ login()

ilPDOAuthentication::login ( )

protected

Definition at line 85 of file class.ilPDOAuthentication.php.

References setAuth().

Referenced by start().

     {
         if (!empty($this->username) && $this->verifyPassword($this->username, $this->password)) {
             $this->setAuth($this->username);
         } else {
             $this->status = AUTH_WRONG_LOGIN;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logout()

ilPDOAuthentication::logout ( )

Returns: void

Implements ilAuthPDOInterface.

Definition at line 139 of file class.ilPDOAuthentication.php.

References $_SESSION.

     {
         $_SESSION['_authsession'] = null;
     }

◆ sessionValidThru()

ilPDOAuthentication::sessionValidThru ( )

Returns the time up to the session is valid.

public

Returns: integer

Implements ilAuthPDOInterface.

Definition at line 133 of file class.ilPDOAuthentication.php.

References time.

     {
         return time() + 1000000;
     }

◆ setAuth()

ilPDOAuthentication::setAuth ( $username )

private

Parameters

$username

Definition at line 162 of file class.ilPDOAuthentication.php.

References $_SESSION, $password, $username, ilObjUser\_loginExists(), array, ilUserPasswordManager\getInstance(), and ilObjectFactory\getInstanceByObjId().

Referenced by login().

     {
         //        session_regenerate_id(true); doesn't seem to work on PHP7
 
         if (!isset($_SESSION['_authsession'])) {
             $_SESSION['_authsession'] = array();
         }
 
         $_SESSION['_authsession']['username'] = $username;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExpire()

ilPDOAuthentication::setExpire	(	$time,
		$add = `false`
	)

Set the maximum expire time.

Parameters

int	$time	Time in seconds
bool	$add	Add time to current expire time or not

Returns: void

Implements ilAuthPDOInterface.

Definition at line 56 of file class.ilPDOAuthentication.php.

     {
         // TODO: Implement setExpire() method.
     }

◆ setIdle()

ilPDOAuthentication::setIdle	(	$time,
		$add = `false`
	)

Set maximum idle time.

Parameters

int	$time	Time in seconds.
bool	$add	Add to current idle time?

Returns: void

Implements ilAuthPDOInterface.

Definition at line 44 of file class.ilPDOAuthentication.php.

     {
         // TODO: Implement setIdle() method.
     }

◆ start()

ilPDOAuthentication::start ( )

Start new auth session.

Returns: void

Implements ilAuthPDOInterface.

Definition at line 66 of file class.ilPDOAuthentication.php.

References assignData(), checkAuth(), and login().

     {
         // TODO SAME AS old AUTH
         $this->assignData();
         if (!$this->checkAuth() && $this->allowLogin) {
             $this->login();
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $_postPassword

ilPDOAuthentication::$_postPassword = 'password'

protected

Definition at line 13 of file class.ilPDOAuthentication.php.

Referenced by assignData().

◆ $_postUsername

ilPDOAuthentication::$_postUsername = 'username'

protected

Definition at line 12 of file class.ilPDOAuthentication.php.

Referenced by assignData().

◆ $_sessionName

ilPDOAuthentication::$_sessionName = '_authsession'

protected

Definition at line 10 of file class.ilPDOAuthentication.php.

Referenced by __construct().

◆ $advancedsecurity

ilPDOAuthentication::$advancedsecurity

protected

Definition at line 14 of file class.ilPDOAuthentication.php.

◆ $allowLogin

ilPDOAuthentication::$allowLogin = true

protected

Definition at line 11 of file class.ilPDOAuthentication.php.

◆ $cookie

ilPDOAuthentication::$cookie

protected

Definition at line 23 of file class.ilPDOAuthentication.php.

◆ $enableLogging

ilPDOAuthentication::$enableLogging

protected

Definition at line 15 of file class.ilPDOAuthentication.php.

◆ $password

ilPDOAuthentication::$password

protected

Definition at line 19 of file class.ilPDOAuthentication.php.

Referenced by setAuth().

◆ $post

ilPDOAuthentication::$post

protected

Definition at line 22 of file class.ilPDOAuthentication.php.

◆ $regenerateSessionId

ilPDOAuthentication::$regenerateSessionId

protected

Definition at line 16 of file class.ilPDOAuthentication.php.

◆ $server

ilPDOAuthentication::$server

protected

Definition at line 21 of file class.ilPDOAuthentication.php.

◆ $session

ilPDOAuthentication::$session

protected

Definition at line 20 of file class.ilPDOAuthentication.php.

◆ $status

ilPDOAuthentication::$status = ''

protected

Definition at line 17 of file class.ilPDOAuthentication.php.

Referenced by getStatus().

◆ $username

ilPDOAuthentication::$username = null

protected

Definition at line 18 of file class.ilPDOAuthentication.php.

Referenced by setAuth().

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

Services/Authentication/classes/PDO/class.ilPDOAuthentication.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignData()

◆ checkAuth()

◆ getAuth()

◆ getStatus()

◆ getUsername()

◆ login()

◆ logout()

◆ sessionValidThru()

◆ setAuth()

◆ setExpire()

◆ setIdle()

◆ start()

Field Documentation

◆ $_postPassword

◆ $_postUsername

◆ $_sessionName

◆ $advancedsecurity

◆ $allowLogin

◆ $cookie

◆ $enableLogging

◆ $password

◆ $post

◆ $regenerateSessionId

◆ $server

◆ $session

◆ $status

◆ $username