ilAuthContainerDecorator Class Reference

Abstract decorator for PEAR::Auth Base class for all Ilias Authentication classes. More...

Collaboration diagram for ilAuthContainerDecorator:

Public Member Functions
	__construct ()
	Constructor. More...
	__call ($name, $arguments)
	Wrapper for all PEAR_Auth_Container methods. More...
	getContainer ()
	get pear container More...
	setContainer ($a_container)
	set pear container More...
	getAuthObject ()
	appendParameter ($a_key, $a_value)
	Add a parameter. More...
	appendParameters ($a_params)
	getParameters ()
	get auth container parameters More...
	loginObserver ($a_username, $a_auth)
	failedLoginObserver ($a_username, $a_auth)
	Called from base class after failed login. More...
	checkAuthObserver ($a_username, $a_auth)
	Called from base class after call of checkAuth. More...
	logoutObserver ($a_username, $a_auth)
	Called from base class after logout. More...

Protected Member Functions
	initContainer ()
	Init the PEAR container. More...

Protected Attributes
	$parameter = array()

Private Attributes
	$container = null

Detailed Description

Abstract decorator for PEAR::Auth Base class for all Ilias Authentication classes.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 34 of file class.ilAuthContainerDecorator.php.

Constructor & Destructor Documentation

__construct()

ilAuthContainerDecorator::__construct

(

)

Constructor.

Parameters

Definition at line 43 of file class.ilAuthContainerDecorator.php.

        {

        }

Member Function Documentation

__call()

ilAuthContainerDecorator::__call (   $name,   $arguments  )

final

Wrapper for all PEAR_Auth_Container methods.

Parameters

Definition at line 55 of file class.ilAuthContainerDecorator.php.

References initContainer().

        {
                return call_user_func_array(array($this->container,$name),$arguments);
        }

Here is the call graph for this function:

appendParameter()

ilAuthContainerDecorator::appendParameter	(		$a_key,
			$a_value
	)

Add a parameter.

Used for contructor in PEAR_Auth_Container

Definition at line 90 of file class.ilAuthContainerDecorator.php.

        {
                $this->parameter[$a_key] = $a_value;
        }

appendParameters()

ilAuthContainerDecorator::appendParameters

(

$a_params

)

Definition at line 95 of file class.ilAuthContainerDecorator.php.

        {
                $this->parameter = array_merge($this->parameter,$a_params);     
        }

checkAuthObserver()

ilAuthContainerDecorator::checkAuthObserver	(		$a_username,
			$a_auth
	)

Called from base class after call of checkAuth.

Parameters

string	username
object	PEAR auth object

Definition at line 147 of file class.ilAuthContainerDecorator.php.

References $ilLog.

        {
                global $ilLog;
                
                //$ilLog->write(__METHOD__.': checkAuth called');
        
                return true;
        }

failedLoginObserver()

ilAuthContainerDecorator::failedLoginObserver	(		$a_username,
			$a_auth
	)

Called from base class after failed login.

Parameters

string	username
object	PEAR auth object

Definition at line 130 of file class.ilAuthContainerDecorator.php.

References $_SERVER, and $ilLog.

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': login failed for user '.$a_username.
                        ', remote:'.$_SERVER['REMOTE_ADDR'].':'.$_SERVER['REMOTE_PORT'].
                        ', server:'.$_SERVER['SERVER_ADDR'].':'.$_SERVER['SERVER_PORT']
                );
                return false;
        }

getAuthObject()

ilAuthContainerDecorator::getAuthObject

(

)

Definition at line 82 of file class.ilAuthContainerDecorator.php.

References getContainer().

        {
                return $this->getContainer()->_auth_obj;
        }

Here is the call graph for this function:

getContainer()

ilAuthContainerDecorator::getContainer

(

)

get pear container

Definition at line 68 of file class.ilAuthContainerDecorator.php.

References $container.

Referenced by getAuthObject().

        {
                return $this->container;
        }

Here is the caller graph for this function:

getParameters()

ilAuthContainerDecorator::getParameters

(

)

get auth container parameters

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

        {
                return $this->parameter ? $this->parameter : array();
        }

initContainer()

ilAuthContainerDecorator::initContainer ( )

abstractprotected

Init the PEAR container.

Referenced by __call().

Here is the caller graph for this function:

loginObserver()

ilAuthContainerDecorator::loginObserver	(		$a_username,
			$a_auth
	)

Returns

Parameters

object	$a_username
object	$a_auth

Definition at line 114 of file class.ilAuthContainerDecorator.php.

References $_SERVER, and $ilLog.

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': logged in as '.$a_username.
                        ', remote:'.$_SERVER['REMOTE_ADDR'].':'.$_SERVER['REMOTE_PORT'].
                        ', server:'.$_SERVER['SERVER_ADDR'].':'.$_SERVER['SERVER_PORT']
                );
        }

logoutObserver()

ilAuthContainerDecorator::logoutObserver	(		$a_username,
			$a_auth
	)

Called from base class after logout.

Parameters

string	username
object	PEAR auth object

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

References $_SERVER, and $ilLog.

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': User logged out: '.$a_username.
                        ', remote:'.$_SERVER['REMOTE_ADDR'].':'.$_SERVER['REMOTE_PORT'].
                        ', server:'.$_SERVER['SERVER_ADDR'].':'.$_SERVER['SERVER_PORT']
                );
        }

setContainer()

ilAuthContainerDecorator::setContainer

(

$a_container

)

set pear container

Definition at line 76 of file class.ilAuthContainerDecorator.php.

        {
                $this->container = $a_container;
        }

Field Documentation

$container

ilAuthContainerDecorator::$container = null

private

Definition at line 36 of file class.ilAuthContainerDecorator.php.

Referenced by getContainer().

$parameter

ilAuthContainerDecorator::$parameter = array()

protected

Definition at line 37 of file class.ilAuthContainerDecorator.php.

---

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

• Services/Authentication/classes/class.ilAuthContainerDecorator.php