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 ($a_status)
	Enable node mapping. More...

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

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

	enableCourseAllocation ($a_stat)

	isCourseAllocationEnabled ()

	setDefaultCourseCategory ($a_def)

	getDefaultCourseCategory ()

	isAllInOneCategoryEnabled ()

	enableAllInOne ($a_stat)

	setAllInOneCategory ($a_cat)

	getAllInOneCategory ()

	enableAttributeMapping ($a_stat)

	isAttributeMappingEnabled ()

	setRoleMappings ($a_mappings)

	getRoleMappings ()

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

Static Public Member Functions
static	getInstance ()
	Get singeleton instance. More...

static	getInstanceByServerMid ($a_server_id, $a_mid)
	Get instance. More...

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

	getStorage ()
	Get storage. More...

	initStorage ()
	Init storage. More...

	read ()
	Read settings from db. More...

Private Attributes
	$storage = null

	$server_id = 0

	$mid = 0

	$directory_active = false

	$create_empty_containers = false

	$course_active = false
	Course allocation. More...

	$default_cat = 0

	$allinone = false

	$allinone_cat = 0

	$attributes = false

	$role_mappings = array()

Static Private Attributes
static	$instances = array()

Detailed Description

Genearal.

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

Constructor & Destructor Documentation

◆ __construct()

ilECSNodeMappingSettings::__construct	(	$a_server_id,
		$a_mid
	)

protected

Singeleton constructor.

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

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

References initStorage(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ enableAllInOne()

ilECSNodeMappingSettings::enableAllInOne ( $a_stat )

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

        {
                $this->allinone = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

◆ enableAttributeMapping()

ilECSNodeMappingSettings::enableAttributeMapping ( $a_stat )

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

        {
                $this->attributes = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

◆ enableCourseAllocation()

ilECSNodeMappingSettings::enableCourseAllocation ( $a_stat )

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

        {
                $this->course_active = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

◆ enableDirectoryMapping()

ilECSNodeMappingSettings::enableDirectoryMapping ( $a_status )

Enable node mapping.

Parameters

bool $a_status

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

        {
                $this->directory_active = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

◆ enableEmptyContainerCreation()

ilECSNodeMappingSettings::enableEmptyContainerCreation ( $a_status )

enable creation of empty containers

Parameters

bool $a_status

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

        {
                $this->create_empty_containers = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

◆ getAllInOneCategory()

ilECSNodeMappingSettings::getAllInOneCategory ( )

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

        {
                return $this->allinone_cat;
        }

References $allinone_cat.

Referenced by update().

Here is the caller graph for this function:

◆ getDefaultCourseCategory()

ilECSNodeMappingSettings::getDefaultCourseCategory ( )

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

        {
                return $this->default_cat;
        }

References $default_cat.

Referenced by update().

Here is the caller graph for this function:

◆ getInstance()

static ilECSNodeMappingSettings::getInstance ( )

static

Get singeleton instance.

Returns: ilECSNodeMappingSettings

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

        {
                $GLOBALS['ilLog']->write(__METHOD__.': Deprecated call...');
                $GLOBALS['ilLog']->logStack();
                
                if(self::$instance)
                {
                        return self::$instance;
                }
                return self::$instance = new ilECSNodeMappingSettings();
        }

References $GLOBALS.

◆ getInstanceByServerMid()

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

static

Get instance.

Parameters

type	$a_server_id
type	$a_mid

Returns: ilECSNodeMappingSettings

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

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

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

Here is the caller graph for this function:

◆ getMid()

ilECSNodeMappingSettings::getMid ( )

Get mid of sender.

Returns: type

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

        {
                return $this->mid;
        }

References $mid.

Referenced by initStorage().

Here is the caller graph for this function:

◆ getRoleMappings()

ilECSNodeMappingSettings::getRoleMappings ( )

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

        {
                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.

Returns: type

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

        {
                return $this->server_id;
        }

References $server_id.

Referenced by initStorage().

Here is the caller graph for this function:

◆ getStorage()

ilECSNodeMappingSettings::getStorage ( )

protected

Get storage.

Returns: ilSetting

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

        {
                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 219 of file class.ilECSNodeMappingSettings.php.

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

References $ilSetting, 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 151 of file class.ilECSNodeMappingSettings.php.

        {
                return $this->allinone;
        }

References $allinone.

Referenced by update().

Here is the caller graph for this function:

◆ isAttributeMappingEnabled()

ilECSNodeMappingSettings::isAttributeMappingEnabled ( )

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

        {
                return $this->attributes;
        }

References $attributes.

Referenced by update().

Here is the caller graph for this function:

◆ isCourseAllocationEnabled()

ilECSNodeMappingSettings::isCourseAllocationEnabled ( )

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

        {
                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.

Returns: bool

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

        {
                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.

Returns: bool

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

        {
                return $this->create_empty_containers;
        }

References $create_empty_containers.

Referenced by update().

Here is the caller graph for this function:

◆ read()

ilECSNodeMappingSettings::read ( )

protected

Read settings from db.

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

        {
                $this->enableDirectoryMapping($this->getStorage()->get('directory_active', $this->directory_active));
                $this->enableEmptyContainerCreation($this->getStorage()->get('create_empty'),$this->create_empty_containers);
                $this->enableCourseAllocation($this->getStorage()->get('course_active'),$this->course_active);
                $this->setDefaultCourseCategory($this->getStorage()->get('default_category'),$this->default_cat);
                $this->enableAllInOne($this->getStorage()->get('allinone'),$this->allinone);
                $this->setAllInOneCategory($this->getStorage()->get('allinone_cat'),$this->allinone_cat);
                $this->enableAttributeMapping($this->getStorage()->get('attributes'),$this->attributes);
                $this->setRoleMappings(unserialize($this->getStorage()->get('role_mappings')),serialize($this->role_mappings));
        }

References enableAllInOne(), enableAttributeMapping(), enableCourseAllocation(), enableDirectoryMapping(), enableEmptyContainerCreation(), getStorage(), setAllInOneCategory(), 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 ( $a_cat )

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

        {
                $this->allinone_cat = $a_cat;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setDefaultCourseCategory()

ilECSNodeMappingSettings::setDefaultCourseCategory ( $a_def )

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

        {
                $this->default_cat = $a_def;
        }

Referenced by read().

Here is the caller graph for this function:

◆ setRoleMappings()

ilECSNodeMappingSettings::setRoleMappings ( $a_mappings )

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

        {
                $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 194 of file class.ilECSNodeMappingSettings.php.

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