Shibboleth role assignment rule. More...

Collaboration diagram for ilShibbolethRoleAssignmentRule:

Public Member Functions
	__construct ($a_rule_id=0)

	setRuleId ($a_id)

	getRuleId ()

	setRoleId ($a_id)

	getRoleId ()

	setName ($a_name)

	getName ()

	setValue ($a_value)

	getValue ()

	enablePlugin ($a_status)

	isPluginActive ()

	enableAddOnUpdate ($a_status)

	isAddOnUpdateEnabled ()

	enableRemoveOnUpdate ($a_status)

	isRemoveOnUpdateEnabled ()

	setPluginId ($a_id)

	getPluginId ()

	conditionToString ()

	validate ()

	delete ()

	add ()

	update ()

	matches ($a_data)

	doesMatch (array $a_data)

Data Fields
const	ERR_MISSING_NAME = 'shib_missing_attr_name'

const	ERR_MISSING_VALUE = 'shib_missing_attr_value'

const	ERR_MISSING_ROLE = 'shib_missing_role'

const	ERR_MISSING_PLUGIN_ID = 'shib_missing_plugin_id'

const	TABLE_NAME = 'shib_role_assignment'

Protected Member Functions
	wildcardCompare ($a_str1, $a_str2)

Protected Attributes
	$db

Private Member Functions
	read ()

Private Attributes
	$rule_id = 0

	$role_id = 0

	$attribute_name = ''

	$attribute_value = ''

	$plugin_active = false

	$add_on_update = false

	$remove_on_update = false

	$plugin_id = 0

Detailed Description

Shibboleth role assignment rule.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Fabian Schmid fabia.nosp@m.n.sc.nosp@m.hmid@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$

Definition at line 35 of file class.ilShibbolethRoleAssignmentRule.php.

Constructor & Destructor Documentation

◆ __construct()

ilShibbolethRoleAssignmentRule::__construct ( $a_rule_id = 0 )

Parameters

int $a_rule_id

Definition at line 83 of file class.ilShibbolethRoleAssignmentRule.php.

References $DIC, $ilDB, and read().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $this->db = $ilDB;
         $this->rule_id = $a_rule_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilShibbolethRoleAssignmentRule::add ( )

Returns: bool

Definition at line 293 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, getName(), getPluginId(), getRoleId(), getValue(), isAddOnUpdateEnabled(), isPluginActive(), isRemoveOnUpdateEnabled(), and setRuleId().

     {
         $next_id = $this->db->nextId(self::TABLE_NAME);
         $query = 'INSERT INTO ' . self::TABLE_NAME . ' (rule_id,role_id,name,value,plugin,plugin_id,add_on_update,remove_on_update ) ' . 'VALUES( '
             . $this->db->quote($next_id, 'integer') . ', ' . $this->db->quote($this->getRoleId(), 'integer') . ', '
             . $this->db->quote($this->getName(), 'text') . ', ' . $this->db->quote($this->getValue(), 'text') . ', '
             . $this->db->quote((int) $this->isPluginActive(), 'integer') . ', ' . $this->db->quote((int) $this->getPluginId(), 'integer') . ', '
             . $this->db->quote((int) $this->isAddOnUpdateEnabled(), 'integer') . ', '
             . $this->db->quote((int) $this->isRemoveOnUpdateEnabled(), 'integer') . ') ';
         $this->db->manipulate($query);
         $this->setRuleId($this->db->getLastInsertId());
 
         return true;
     }

Here is the call graph for this function:

◆ conditionToString()

ilShibbolethRoleAssignmentRule::conditionToString ( )

Returns: string

Definition at line 240 of file class.ilShibbolethRoleAssignmentRule.php.

References $DIC, $lng, getName(), getPluginId(), getValue(), and isPluginActive().

     {
         global $DIC;
         $lng = $DIC['lng'];
         if ($this->isPluginActive()) {
             return $lng->txt('shib_plugin_id') . ': ' . $this->getPluginId();
         } else {
             return $this->getName() . '=' . $this->getValue();
         }
     }

Here is the call graph for this function:

◆ delete()

ilShibbolethRoleAssignmentRule::delete ( )

Returns: bool

Definition at line 281 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, and getRuleId().

     {
         $query = 'DELETE FROM ' . self::TABLE_NAME . ' ' . 'WHERE rule_id = ' . $this->db->quote($this->getRuleId(), 'integer');
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

◆ doesMatch()

ilShibbolethRoleAssignmentRule::doesMatch ( array $a_data )

Parameters

array $a_data

Returns: bool

Definition at line 371 of file class.ilShibbolethRoleAssignmentRule.php.

References ilShibbolethRoleAssignmentRules\callPlugin(), getName(), getPluginId(), getValue(), and isPluginActive().

     {
         if ($this->isPluginActive()) {
             return ilShibbolethRoleAssignmentRules::callPlugin($this->getPluginId(), $a_data);
         }
         if (!isset($a_data[$this->getName()])) {
             return false;
         }
         $values = $a_data[$this->getName()];
         if (is_array($values)) {
             return in_array($this->getValue(), $values);
         } else {
             $pattern = str_replace('*', '.*?', $this->getValue());
 
             return (bool) preg_match('/^' . $pattern . '$/us', $values);
         }
     }

Here is the call graph for this function:

◆ enableAddOnUpdate()

ilShibbolethRoleAssignmentRule::enableAddOnUpdate ( $a_status )

Parameters

$a_status

Definition at line 186 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->add_on_update = $a_status;
     }

Here is the caller graph for this function:

◆ enablePlugin()

ilShibbolethRoleAssignmentRule::enablePlugin ( $a_status )

Parameters

$a_status

Definition at line 168 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->plugin_active = $a_status;
     }

Here is the caller graph for this function:

◆ enableRemoveOnUpdate()

ilShibbolethRoleAssignmentRule::enableRemoveOnUpdate ( $a_status )

Parameters

$a_status

Definition at line 204 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->remove_on_update = $a_status;
     }

Here is the caller graph for this function:

◆ getName()

ilShibbolethRoleAssignmentRule::getName ( )

Returns: string

Definition at line 141 of file class.ilShibbolethRoleAssignmentRule.php.

References $attribute_name.

Referenced by add(), conditionToString(), doesMatch(), matches(), update(), and validate().

     {
         return $this->attribute_name;
     }

Here is the caller graph for this function:

◆ getPluginId()

ilShibbolethRoleAssignmentRule::getPluginId ( )

Returns: int

Definition at line 231 of file class.ilShibbolethRoleAssignmentRule.php.

References $plugin_id.

Referenced by add(), conditionToString(), doesMatch(), matches(), update(), and validate().

     {
         return $this->plugin_id;
     }

Here is the caller graph for this function:

◆ getRoleId()

ilShibbolethRoleAssignmentRule::getRoleId ( )

Returns: int

Definition at line 123 of file class.ilShibbolethRoleAssignmentRule.php.

References $role_id.

Referenced by add(), update(), and validate().

     {
         return $this->role_id;
     }

Here is the caller graph for this function:

◆ getRuleId()

ilShibbolethRoleAssignmentRule::getRuleId ( )

Returns: int

Definition at line 105 of file class.ilShibbolethRoleAssignmentRule.php.

References $rule_id.

Referenced by delete(), read(), and update().

     {
         return $this->rule_id;
     }

Here is the caller graph for this function:

◆ getValue()

ilShibbolethRoleAssignmentRule::getValue ( )

Returns: string

Definition at line 159 of file class.ilShibbolethRoleAssignmentRule.php.

References $attribute_value.

Referenced by add(), conditionToString(), doesMatch(), matches(), update(), and validate().

     {
         return $this->attribute_value;
     }

Here is the caller graph for this function:

◆ isAddOnUpdateEnabled()

ilShibbolethRoleAssignmentRule::isAddOnUpdateEnabled ( )

Returns: bool

Definition at line 195 of file class.ilShibbolethRoleAssignmentRule.php.

References $add_on_update.

Referenced by add(), and update().

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

Here is the caller graph for this function:

◆ isPluginActive()

ilShibbolethRoleAssignmentRule::isPluginActive ( )

Returns: bool

Definition at line 177 of file class.ilShibbolethRoleAssignmentRule.php.

References $plugin_active.

Referenced by add(), conditionToString(), doesMatch(), matches(), update(), and validate().

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

Here is the caller graph for this function:

◆ isRemoveOnUpdateEnabled()

ilShibbolethRoleAssignmentRule::isRemoveOnUpdateEnabled ( )

Returns: bool

Definition at line 213 of file class.ilShibbolethRoleAssignmentRule.php.

References $remove_on_update.

Referenced by add(), and update().

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

Here is the caller graph for this function:

◆ matches()

ilShibbolethRoleAssignmentRule::matches ( $a_data )

Parameters

$a_data

Deprecated:

Returns: bool

Definition at line 333 of file class.ilShibbolethRoleAssignmentRule.php.

References ilShibbolethRoleAssignmentRules\callPlugin(), getName(), getPluginId(), getValue(), isPluginActive(), and wildcardCompare().

     {
         if ($this->isPluginActive()) {
             return ilShibbolethRoleAssignmentRules::callPlugin($this->getPluginId(), $a_data);
         }
         // No value
         if (!isset($a_data[$this->getName()])) {
             return false;
         }
         $values = $a_data[$this->getName()];
         if (is_array($values)) {
             return in_array($this->getValue(), $values);
         } else {
             return $this->wildcardCompare($this->getValue(), $values);
         }
     }

Here is the call graph for this function:

◆ read()

ilShibbolethRoleAssignmentRule::read ( )

private

Returns: bool

Definition at line 393 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, $res, $row, enableAddOnUpdate(), enablePlugin(), enableRemoveOnUpdate(), ilDBConstants\FETCHMODE_OBJECT, getRuleId(), setName(), setPluginId(), setRoleId(), and setValue().

Referenced by __construct().

     {
         if (!$this->getRuleId()) {
             return true;
         }
         $query = 'SELECT * FROM ' . self::TABLE_NAME . ' ' . 'WHERE rule_id = ' . $this->db->quote($this->getRuleId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setRoleId($row->role_id);
             $this->setName($row->name);
             $this->setValue($row->value);
             $this->enablePlugin($row->plugin);
             $this->setPluginId($row->plugin_id);
             $this->enableAddOnUpdate($row->add_on_update);
             $this->enableRemoveOnUpdate($row->remove_on_update);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setName()

ilShibbolethRoleAssignmentRule::setName ( $a_name )

Parameters

$a_name

Definition at line 132 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->attribute_name = $a_name;
     }

Here is the caller graph for this function:

◆ setPluginId()

ilShibbolethRoleAssignmentRule::setPluginId ( $a_id )

Parameters

$a_id

Definition at line 222 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->plugin_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRoleId()

ilShibbolethRoleAssignmentRule::setRoleId ( $a_id )

Parameters

$a_id

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

Referenced by read().

     {
         $this->role_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRuleId()

ilShibbolethRoleAssignmentRule::setRuleId ( $a_id )

Parameters

$a_id

Definition at line 96 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by add().

     {
         $this->rule_id = $a_id;
     }

Here is the caller graph for this function:

◆ setValue()

ilShibbolethRoleAssignmentRule::setValue ( $a_value )

Parameters

$a_value

Definition at line 150 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

     {
         $this->attribute_value = $a_value;
     }

Here is the caller graph for this function:

◆ update()

ilShibbolethRoleAssignmentRule::update ( )

Returns: bool

Definition at line 312 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, getName(), getPluginId(), getRoleId(), getRuleId(), getValue(), isAddOnUpdateEnabled(), isPluginActive(), and isRemoveOnUpdateEnabled().

     {
         $query = 'UPDATE ' . self::TABLE_NAME . ' ' . 'SET role_id = ' . $this->db->quote($this->getRoleId(), 'integer') . ', ' . 'name = '
             . $this->db->quote($this->getName(), 'text') . ', ' . 'value = ' . $this->db->quote($this->getValue(), 'text') . ', ' . 'plugin = '
             . $this->db->quote((int) $this->isPluginActive(), 'integer') . ', ' . 'plugin_id = '
             . $this->db->quote((int) $this->getPluginId(), 'integer') . ', ' . 'add_on_update = '
             . $this->db->quote((int) $this->isAddOnUpdateEnabled(), 'integer') . ', ' . 'remove_on_update = '
             . $this->db->quote((int) $this->isRemoveOnUpdateEnabled(), 'integer') . ' '
             . 'WHERE rule_id = ' . $this->db->quote($this->getRuleId(), 'integer');
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilShibbolethRoleAssignmentRule::validate ( )

Returns: string

Definition at line 255 of file class.ilShibbolethRoleAssignmentRule.php.

References getName(), getPluginId(), getRoleId(), getValue(), and isPluginActive().

     {
         if (!$this->getRoleId()) {
             return self::ERR_MISSING_ROLE;
         }
         if (!$this->isPluginActive()) {
             if (!$this->getName()) {
                 return self::ERR_MISSING_NAME;
             }
             if (!$this->getValue()) {
                 return self::ERR_MISSING_VALUE;
             }
         } else {
             // check plugin id is given
             if (!$this->getPluginId()) {
                 return self::ERR_MISSING_PLUGIN_ID;
             }
         }
 
         return '';
     }

Here is the call graph for this function:

◆ wildcardCompare()

ilShibbolethRoleAssignmentRule::wildcardCompare	(	$a_str1,
		$a_str2
	)

protected

Parameters

$a_str1
$a_str2

Deprecated:

Returns: bool

Definition at line 358 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by matches().

     {
         $pattern = str_replace('*', '.*?', $a_str1);
 
         return (bool) preg_match("/" . $pattern . "/us", $a_str2);
     }

Here is the caller graph for this function:

Field Documentation

◆ $add_on_update

ilShibbolethRoleAssignmentRule::$add_on_update = false

private

Definition at line 69 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by isAddOnUpdateEnabled().

◆ $attribute_name

ilShibbolethRoleAssignmentRule::$attribute_name = ''

private

Definition at line 57 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by getName().

◆ $attribute_value

ilShibbolethRoleAssignmentRule::$attribute_value = ''

private

Definition at line 61 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by getValue().

◆ $db

ilShibbolethRoleAssignmentRule::$db

protected

Definition at line 45 of file class.ilShibbolethRoleAssignmentRule.php.

◆ $plugin_active

ilShibbolethRoleAssignmentRule::$plugin_active = false

private

Definition at line 65 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by isPluginActive().

◆ $plugin_id

ilShibbolethRoleAssignmentRule::$plugin_id = 0

private

Definition at line 77 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by getPluginId().

◆ $remove_on_update

ilShibbolethRoleAssignmentRule::$remove_on_update = false

private

Definition at line 73 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by isRemoveOnUpdateEnabled().

◆ $role_id

ilShibbolethRoleAssignmentRule::$role_id = 0

private

Definition at line 53 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by getRoleId().

◆ $rule_id

ilShibbolethRoleAssignmentRule::$rule_id = 0

private

Definition at line 49 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by getRuleId().

◆ ERR_MISSING_NAME

const ilShibbolethRoleAssignmentRule::ERR_MISSING_NAME = 'shib_missing_attr_name'

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

◆ ERR_MISSING_PLUGIN_ID

const ilShibbolethRoleAssignmentRule::ERR_MISSING_PLUGIN_ID = 'shib_missing_plugin_id'

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

◆ ERR_MISSING_ROLE

const ilShibbolethRoleAssignmentRule::ERR_MISSING_ROLE = 'shib_missing_role'

Definition at line 39 of file class.ilShibbolethRoleAssignmentRule.php.

◆ ERR_MISSING_VALUE

const ilShibbolethRoleAssignmentRule::ERR_MISSING_VALUE = 'shib_missing_attr_value'

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

◆ TABLE_NAME

const ilShibbolethRoleAssignmentRule::TABLE_NAME = 'shib_role_assignment'

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

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

Services/AuthShibboleth/classes/class.ilShibbolethRoleAssignmentRule.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ conditionToString()

◆ delete()

◆ doesMatch()

◆ enableAddOnUpdate()

◆ enablePlugin()

◆ enableRemoveOnUpdate()

◆ getName()

◆ getPluginId()

◆ getRoleId()

◆ getRuleId()

◆ getValue()

◆ isAddOnUpdateEnabled()

◆ isPluginActive()

◆ isRemoveOnUpdateEnabled()

◆ matches()

◆ read()

◆ setName()

◆ setPluginId()

◆ setRoleId()

◆ setRuleId()

◆ setValue()

◆ update()

◆ validate()

◆ wildcardCompare()

Field Documentation

◆ $add_on_update

◆ $attribute_name

◆ $attribute_value

◆ $db

◆ $plugin_active

◆ $plugin_id

◆ $remove_on_update

◆ $role_id

◆ $rule_id

◆ ERR_MISSING_NAME

◆ ERR_MISSING_PLUGIN_ID

◆ ERR_MISSING_ROLE

◆ ERR_MISSING_VALUE

◆ TABLE_NAME