ilAuthContainerLDAP Class Reference [Services/LDAP]

Overwritten Pear class AuthContainerLDAP This class is overwritten to support nested groups. More...

Inheritance diagram for ilAuthContainerLDAP:

Collaboration diagram for ilAuthContainerLDAP:

Public Member Functions
	__construct (ilLDAPServer $server, $a_params)
	Constructor.
	enableOptionalGroupCheck ()
	enable optional group check
	enabledOptionalGroupCheck ()
	Check if optional group check is enabled.
	checkGroup ($a_name)
	check group overwritten base class
	_debug ($a_message= '', $a_line=0)
	Overwritten debug method Writes infos to log file.
Private Member Functions
	updateUserFilter ()
	Update user filter.
Private Attributes
	$optional_check = false
	$log = null
	$server = null

---

Detailed Description

Overwritten Pear class AuthContainerLDAP This class is overwritten to support nested groups.

Author:

Stefan Meyer <smeyer@databay.de>

Version:

$Id$

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

---

Constructor & Destructor Documentation

ilAuthContainerLDAP::__construct	(	ilLDAPServer $	server,
		$	a_params
	)

Constructor.

public

Parameters:

array

array of pear parameters

Definition at line 50 of file class.ilAuthContainerLDAP.php.

References $ilLog.

        {
                global $ilLog;
                
                $this->server = $server;
                parent::__construct($a_params);
                $this->log = $ilLog;
        }

---

Member Function Documentation

ilAuthContainerLDAP::_debug	(	$	a_message = '',
		$	a_line = 0
	)

Overwritten debug method Writes infos to log file.

public

Parameters:

	string	message
	int	line

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

        {
                if(is_object($this->log))
                {
                        $this->log->write('LDAP PEAR: '.$a_message);
                }
                parent::_debug($a_message,$a_line);
        }

ilAuthContainerLDAP::checkGroup

(

$

a_name

)

check group overwritten base class

public

Parameters:

string

user name (DN or external account name)

Definition at line 92 of file class.ilAuthContainerLDAP.php.

        {
                $this->log->write(__METHOD__.': checking group restrictions...');

                // if there are multiple groups define check all of them for membership
                $groups = $this->server->getGroupNames();
                
                if(!count($groups))
                {
                        $this->log->write(__METHOD__.': No group restrictions found.');
                        return true;
                }
                elseif($this->server->isMembershipOptional() and !$this->optional_check)
                {
                        $this->log->write(__METHOD__.': Group membership is optional.');
                        return true;
                }
        
                foreach($groups as $group)
                {
                        $this->options['group'] = $group;
                        
                        if(parent::checkGroup($a_name))
                        {
                                return true;
                        }
                }
                return false;   
        }

ilAuthContainerLDAP::enabledOptionalGroupCheck

(

)

Check if optional group check is enabled.

public

Definition at line 78 of file class.ilAuthContainerLDAP.php.

        {
                return (bool) $this->optional_check;
        }

ilAuthContainerLDAP::enableOptionalGroupCheck

(

)

enable optional group check

public

Parameters:

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

References updateUserFilter().

        {
                $this->optional_check = true;
                $this->updateUserFilter();
        }

Here is the call graph for this function:

ilAuthContainerLDAP::updateUserFilter

(

)

[private]

Update user filter.

private

Definition at line 145 of file class.ilAuthContainerLDAP.php.

Referenced by enableOptionalGroupCheck().

        {
                $this->options['userfilter'] = $this->server->getGroupUserFilter();
        }

Here is the caller graph for this function:

---

Field Documentation

ilAuthContainerLDAP::$log = null [private]

Definition at line 40 of file class.ilAuthContainerLDAP.php.

ilAuthContainerLDAP::$optional_check = false [private]

Definition at line 38 of file class.ilAuthContainerLDAP.php.

ilAuthContainerLDAP::$server = null [private]

Definition at line 41 of file class.ilAuthContainerLDAP.php.

---

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

• Services/LDAP/classes/class.ilAuthContainerLDAP.php