class.ilExternalAuthUserAttributeMapping.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Authentication/classes/External/UserAttributeMapping/class.ilExternalAuthUserAttributeMappingRule.php';

class ilExternalAuthUserAttributeMapping implements ArrayAccess, Countable, Iterator
{
    protected $db;

    protected $authMode = '';

    protected $authSourceId;

    protected $mapping = array();

    public function __construct($authMode, $authSourceId = 0)
    {
        assert(is_string($authMode));
        assert(is_numeric($authSourceId));

        $this->db = $GLOBALS['DIC']->database();

        $this->setAuthMode($authMode);
        $this->setAuthSourceId($authSourceId);

        $this->read();
    }

    public function getAuthSourceId()
    {
        return $this->authSourceId;
    }

    public function setAuthSourceId($authSourceId)
    {
        $this->authSourceId = $authSourceId;
    }

    public function getAuthMode()
    {
        return $this->authMode;
    }

    public function setAuthMode($authMode)
    {
        $this->authMode = $authMode;
    }

    public function getEmptyRule()
    {
        return new ilExternalAuthUserAttributeMappingRule();
    }

    public function offsetExists($offset)
    {
        return isset($this->mapping[$offset]);
    }

    public function offsetGet($offset)
    {
        return $this->offsetExists($offset) ? $this->mapping[$offset] : null;
    }

    public function offsetSet($offset, $value)
    {
        if (is_null($offset)) {
            $this->mapping[] = $value;
        } else {
            $this->mapping[$offset] = $value;
        }
    }

    public function offsetUnset($offset)
    {
        unset($this->mapping[$offset]);
    }

    public function count()
    {
        return count($this->mapping);
    }

    public function current()
    {
        return current($this->mapping);
    }

    public function next()
    {
        next($this->mapping);
    }

    public function key()
    {
        return key($this->mapping);
    }

    public function valid()
    {
        return current($this->mapping);
    }

    public function rewind()
    {
        reset($this->mapping);
    }

    protected function read()
    {
        $this->mapping = array();

        $res = $this->db->queryF(
            'SELECT * FROM auth_ext_attr_mapping WHERE auth_mode = %s AND auth_src_id = %s',
            array('text', 'integer'),
            array($this->getAuthMode(), $this->getAuthSourceId())
        );
        while ($row = $this->db->fetchAssoc($res)) {
            $rule = $this->getEmptyRule();
            $rule->setAttribute($row['attribute']);
            $rule->setExternalAttribute($row['ext_attribute']);
            $rule->updateAutomatically((bool) $row['update_automatically']);

            $this->mapping[$rule->getAttribute()] = $rule;
        }
    }

    public function save()
    {
        foreach ($this->mapping as $rule) {
            $this->db->replace(
                'auth_ext_attr_mapping',
                array(
                    'auth_mode'   => array('text', $this->getAuthMode()),
                    'auth_src_id' => array('integer', $this->getAuthSourceId()),
                    'attribute'   => array('text', $rule->getAttribute())
                ),
                array(
                    'ext_attribute'        => array('text', $rule->getExternalAttribute()),
                    'update_automatically' => array('integer', (int) $rule->isAutomaticallyUpdated())
                )
            );
        }
    }

    public function delete()
    {
        $this->mapping = array();
        $this->db->manipulateF(
            'DELETE FROM auth_ext_attr_mapping WHERE auth_mode = %s AND auth_src_id = %s',
            array('text', 'integer'),
            array($this->getAuthMode(), $this->getAuthSourceId())
        );
    }
}