Collaboration diagram for ilECSNodeMappingSettings:

Public Member Functions
	getServerId ()
	Get server id of setting. More...

	getMid ()
	Get mid of sender. More...

	isDirectoryMappingEnabled ()
	Check if node mapping is enabled. More...

	enableDirectoryMapping (bool $a_status)
	Enable node mapping. More...

	enableEmptyContainerCreation (bool $a_status)
	enable creation of empty containers More...

	isEmptyContainerCreationEnabled ()
	Check if the creation of empty containers (pathes without courses) is enabled. More...

	enableCourseAllocation (bool $a_stat)

	isCourseAllocationEnabled ()

	setDefaultCourseCategory (int $a_default_category)

	getDefaultCourseCategory ()

	isAllInOneCategoryEnabled ()

	enableAllInOne (bool $a_stat)

	setAllInOneCategory (int $a_cat)

	getAllInOneCategory ()

	enableAttributeMapping (bool $a_stat)

	isAttributeMappingEnabled ()

	setRoleMappings (array $a_mappings)

	getRoleMappings ()

	setAuthMode (string $a_auth_mode)
	Set user auth mode. More...

	getAuthMode ()
	Get auth mode. More...

	update ()
	Save settings to db. More...

Static Public Member Functions
static	getInstanceByServerMid (int $a_server_id, int $a_mid)
	Get instance. More...

Protected Member Functions
	__construct (int $a_server_id, int $a_mid)
	Singeleton constructor. More...

	getStorage ()
	Get storage. More...

	initStorage ()
	Init storage. More...

	read ()

Private Attributes
ilSetting	$storage

int	$server_id

int	$mid
	MID of sender. More...

bool	$directory_active = false

bool	$create_empty_containers = false

bool	$course_active = false
	Course allocation. More...

int	$default_cat = 0

bool	$allinone = false

int	$allinone_cat = 0

bool	$attributes = false

array	$role_mappings = array()

string	$auth_mode = null

Static Private Attributes
static array	$instances = []

Detailed Description

Genearal.

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

Constructor & Destructor Documentation

◆ __construct()

ilECSNodeMappingSettings::__construct	(	int	$a_server_id,
		int	$a_mid
	)

protected

Singeleton constructor.

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

    {
        global $DIC;
 
        $this->server_id = $a_server_id;
        $this->mid = $a_mid;
 
        $this->initStorage();
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ enableAllInOne()

ilECSNodeMappingSettings::enableAllInOne ( bool $a_stat )

Definition at line 146 of file class.ilECSNodeMappingSettings.php.

                                                : void
    {
        $this->allinone = $a_stat;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableAttributeMapping()

ilECSNodeMappingSettings::enableAttributeMapping ( bool $a_stat )

Definition at line 161 of file class.ilECSNodeMappingSettings.php.

                                                        : void
    {
        $this->attributes = $a_stat;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableCourseAllocation()

ilECSNodeMappingSettings::enableCourseAllocation ( bool $a_stat )

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

                                                        : void
    {
        $this->course_active = $a_stat;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableDirectoryMapping()

ilECSNodeMappingSettings::enableDirectoryMapping ( bool $a_status )

Enable node mapping.

Definition at line 100 of file class.ilECSNodeMappingSettings.php.

                                                          : void
    {
        $this->directory_active = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableEmptyContainerCreation()

ilECSNodeMappingSettings::enableEmptyContainerCreation ( bool $a_status )

enable creation of empty containers

Definition at line 108 of file class.ilECSNodeMappingSettings.php.

                                                                : void
    {
        $this->create_empty_containers = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ getAllInOneCategory()

ilECSNodeMappingSettings::getAllInOneCategory ( )

Definition at line 156 of file class.ilECSNodeMappingSettings.php.

                                         : int
    {
        return $this->allinone_cat;
    }

References $allinone_cat.

Referenced by update().

Here is the caller graph for this function:

◆ getAuthMode()

ilECSNodeMappingSettings::getAuthMode ( )

Get auth mode.

Definition at line 192 of file class.ilECSNodeMappingSettings.php.

                                 : ?string
    {
        return $this->auth_mode;
    }

References $auth_mode.

Referenced by update().

Here is the caller graph for this function:

◆ getDefaultCourseCategory()

ilECSNodeMappingSettings::getDefaultCourseCategory ( )

Definition at line 136 of file class.ilECSNodeMappingSettings.php.

                                              : int
    {
        return $this->default_cat;
    }

References $default_cat.

Referenced by update().

Here is the caller graph for this function:

◆ getInstanceByServerMid()

static ilECSNodeMappingSettings::getInstanceByServerMid	(	int	$a_server_id,
		int	$a_mid
	)

static

Get instance.

Definition at line 67 of file class.ilECSNodeMappingSettings.php.

                                                                               : ilECSNodeMappingSettings
    {
        $id = $a_server_id . '_' . $a_mid;
        return self::$instances[$id] ?? (self::$instances[$id] = new self($a_server_id, $a_mid));
    }

References $id.

Referenced by ilECSCourseCreationHandler\__construct(), ilECSCmsTreeSynchronizer\__construct(), ilECSCmsCourseCommandQueueHandler\checkAllocationActivation(), ilECSCmsCourseMemberCommandQueueHandler\checkAllocationActivation(), ilECSMappingSettingsGUI\cStart(), ilECSMappingSettingsGUI\cUpdateSettings(), ilECSMappingSettingsGUI\dStart(), ilECSMappingSettingsGUI\dUpdateSettings(), ilECSNodeMappingTreeTableGUI\fillRow(), ilECSAppEventListener\handleMembership(), ilECSMappingSettingsGUI\initFormCSettings(), ilECSMappingSettingsGUI\initFormDSettings(), and ilECSMappingSettingsGUI\setSubTabs().

Here is the caller graph for this function:

◆ getMid()

ilECSNodeMappingSettings::getMid ( )

Get mid of sender.

Definition at line 84 of file class.ilECSNodeMappingSettings.php.

                            : int
    {
        return $this->mid;
    }

References $mid.

Referenced by initStorage().

Here is the caller graph for this function:

◆ getRoleMappings()

ilECSNodeMappingSettings::getRoleMappings ( )

Definition at line 176 of file class.ilECSNodeMappingSettings.php.

                                     : array
    {
        return $this->role_mappings;
    }

References $role_mappings.

Referenced by update().

Here is the caller graph for this function:

◆ getServerId()

ilECSNodeMappingSettings::getServerId ( )

Get server id of setting.

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

                                 : int
    {
        return $this->server_id;
    }

References $server_id.

Referenced by initStorage().

Here is the caller graph for this function:

◆ getStorage()

ilECSNodeMappingSettings::getStorage ( )

protected

Get storage.

Definition at line 217 of file class.ilECSNodeMappingSettings.php.

                                   : ilSetting
    {
        return $this->storage;
    }

References $storage.

Referenced by read(), and update().

Here is the caller graph for this function:

◆ initStorage()

ilECSNodeMappingSettings::initStorage ( )

protected

Init storage.

Definition at line 225 of file class.ilECSNodeMappingSettings.php.

                                    : void
    {
        $this->storage = new ilSetting('ecs_node_mapping_' . $this->getServerId() . '_' . $this->getMid());
    }

References getMid(), and getServerId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAllInOneCategoryEnabled()

ilECSNodeMappingSettings::isAllInOneCategoryEnabled ( )

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

                                               : bool
    {
        return $this->allinone;
    }

References $allinone.

Referenced by update().

Here is the caller graph for this function:

◆ isAttributeMappingEnabled()

ilECSNodeMappingSettings::isAttributeMappingEnabled ( )

Definition at line 166 of file class.ilECSNodeMappingSettings.php.

                                               : bool
    {
        return $this->attributes;
    }

References $attributes.

Referenced by update().

Here is the caller graph for this function:

◆ isCourseAllocationEnabled()

ilECSNodeMappingSettings::isCourseAllocationEnabled ( )

Definition at line 126 of file class.ilECSNodeMappingSettings.php.

                                               : bool
    {
        return $this->course_active;
    }

References $course_active.

Referenced by update().

Here is the caller graph for this function:

◆ isDirectoryMappingEnabled()

ilECSNodeMappingSettings::isDirectoryMappingEnabled ( )

Check if node mapping is enabled.

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

                                               : bool
    {
        return $this->directory_active;
    }

References $directory_active.

Referenced by update().

Here is the caller graph for this function:

◆ isEmptyContainerCreationEnabled()

ilECSNodeMappingSettings::isEmptyContainerCreationEnabled ( )

Check if the creation of empty containers (pathes without courses) is enabled.

Definition at line 116 of file class.ilECSNodeMappingSettings.php.

                                                     : bool
    {
        return $this->create_empty_containers;
    }

References $create_empty_containers.

Referenced by update().

Here is the caller graph for this function:

◆ read()

ilECSNodeMappingSettings::read ( )

protected

Todo:: convert to own database table Read settings from db

Definition at line 235 of file class.ilECSNodeMappingSettings.php.

                             : void
    {
        if ($this->getStorage()->get('directory_active')) {
            $this->enableDirectoryMapping((bool) $this->getStorage()->get('directory_active'));
        }
        if ($this->getStorage()->get('create_empty')) {
            $this->enableEmptyContainerCreation((bool) $this->getStorage()->get('create_empty'));
        }
        if ($this->getStorage()->get('course_active')) {
            $this->enableCourseAllocation((bool) $this->getStorage()->get('course_active'));
        }
        if ($this->getStorage()->get('default_category')) {
            $this->setDefaultCourseCategory((int) $this->getStorage()->get('default_category'));
        }
        if ($this->getStorage()->get('allinone')) {
            $this->enableAllInOne((bool) $this->getStorage()->get('allinone'));
        }
        if ($this->getStorage()->get('allinone_cat')) {
            $this->setAllInOneCategory((int) $this->getStorage()->get('allinone_cat'));
        }
        if ($this->getStorage()->get('attributes')) {
            $this->enableAttributeMapping((bool) $this->getStorage()->get('attributes'));
        }
        if ($this->getStorage()->get('role_mappings')) {
            $this->setRoleMappings(unserialize($this->getStorage()->get('role_mappings'), ['allowed_classes' => true]));
        }
        if ($this->getStorage()->get('auth_mode')) {
            $this->setAuthMode($this->getStorage()->get('auth_mode'));
        }
    }

References enableAllInOne(), enableAttributeMapping(), enableCourseAllocation(), enableDirectoryMapping(), enableEmptyContainerCreation(), getStorage(), setAllInOneCategory(), setAuthMode(), setDefaultCourseCategory(), and setRoleMappings().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllInOneCategory()

ilECSNodeMappingSettings::setAllInOneCategory ( int $a_cat )

Definition at line 151 of file class.ilECSNodeMappingSettings.php.

                                                   : void
    {
        $this->allinone_cat = $a_cat;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setAuthMode()

ilECSNodeMappingSettings::setAuthMode ( string $a_auth_mode )

Set user auth mode.

Definition at line 184 of file class.ilECSNodeMappingSettings.php.

                                                    : void
    {
        $this->auth_mode = $a_auth_mode;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDefaultCourseCategory()

ilECSNodeMappingSettings::setDefaultCourseCategory ( int $a_default_category )

Definition at line 131 of file class.ilECSNodeMappingSettings.php.

                                                                     : void
    {
        $this->default_cat = $a_default_category;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setRoleMappings()

ilECSNodeMappingSettings::setRoleMappings ( array $a_mappings )

Definition at line 171 of file class.ilECSNodeMappingSettings.php.

                                                      : void
    {
        $this->role_mappings = $a_mappings;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilECSNodeMappingSettings::update ( )

Save settings to db.

Definition at line 200 of file class.ilECSNodeMappingSettings.php.

                            : bool
    {
        $this->getStorage()->set('directory_active', (string) $this->isDirectoryMappingEnabled());
        $this->getStorage()->set('create_empty', (string) $this->isEmptyContainerCreationEnabled());
        $this->getStorage()->set('course_active', (string) $this->isCourseAllocationEnabled());
        $this->getStorage()->set('default_category', (string) $this->getDefaultCourseCategory());
        $this->getStorage()->set('allinone', (string) $this->isAllInOneCategoryEnabled());
        $this->getStorage()->set('allinone_cat', (string) $this->getAllInOneCategory());
        $this->getStorage()->set('attributes', (string) $this->isAttributeMappingEnabled());
        $this->getStorage()->set('role_mappings', serialize($this->getRoleMappings()));
        $this->getStorage()->set('auth_mode', $this->getAuthMode());
        return true;
    }