Collaboration diagram for ilECSParticipantSetting:

Public Member Functions
	__construct (int $a_server_id, int $mid)

	getServerId ()
	Get server id. More...

	setMid (int $a_mid)

	getMid ()

	enableExport (bool $a_status)

	isExportEnabled ()

	enableImport (bool $a_status)

	isImportEnabled ()

	setImportType (int $a_type)

	getImportType ()

	setTitle (string $a_title)

	getTitle ()

	getCommunityName ()

	setCommunityName (string $a_name)

	isTokenEnabled ()

	enableToken (bool $a_stat)

	setExportTypes (array $a_types)

	getExportTypes ()

	getOutgoingUsernamePlaceholders ()

	setOutgoingUsernamePlaceholders (array $a_username_placeholders)

	getOutgoingUsernamePlaceholderByAuthMode (string $auth_mode)

	areIncomingLocalAccountsSupported ()

	enableIncomingLocalAccounts (bool $a_status)

	setIncomingAuthType (int $incoming_auth_type)

	getIncomingAuthType ()

	setOutgoingAuthModes (array $auth_modes)

	getOutgoingAuthModes ()

	getOutgoingExternalAuthModes ()

	isOutgoingAuthModeEnabled (string $auth_mode)

	setImportTypes (array $a_types)

	getImportTypes ()

	validate ()

	update ()
	Update Calls create automatically when no entry exists. More...

	delete ()
	Delete one participant entry. More...

Static Public Member Functions
static	getInstance (int $a_server_id, int $mid)
	Get instance by server id and mid. More...

Data Fields
const	AUTH_VERSION_4 = 1

const	AUTH_VERSION_5 = 2

const	PERSON_EPPN = 1

const	PERSON_LUID = 2

const	PERSON_LOGIN = 3

const	PERSON_UID = 4

const	LOGIN_PLACEHOLDER = '[LOGIN]'

const	EXTERNAL_ACCOUNT_PLACEHOLDER = '[EXTERNAL_ACCOUNT]'

const	INCOMING_AUTH_TYPE_INACTIVE = 0

const	INCOMING_AUTH_TYPE_LOGIN_PAGE = 1

const	INCOMING_AUTH_TYPE_SHIBBOLETH = 2

const	OUTGOING_AUTH_MODE_DEFAULT = 'default'

const	VALIDATION_OK = 0

const	ERR_MISSING_USERNAME_PLACEHOLDER = 1

const	IMPORT_UNCHANGED = 0

const	IMPORT_RCRS = 1

const	IMPORT_CRS = 2

const	IMPORT_CMS = 3

Static Protected Attributes
static array	$instances = []

Private Member Functions
	exists ()

	create ()

	read ()
	Read stored entry. More...

Private Attributes
int	$server_id

int	$mid

bool	$export = false

bool	$import = false

int	$import_type = 1

string	$title = ''

string	$cname = ''

bool	$token = true

bool	$dtoken = true

int	$auth_version = self::AUTH_VERSION_4

int	$person_type = self::PERSON_UID

array	$export_types = array()

array	$import_types = array()

array	$username_placeholders = []

bool	$incoming_local_accounts = true

int	$incoming_auth_type = self::INCOMING_AUTH_TYPE_INACTIVE

array	$outgoing_auth_modes = []

bool	$exists = false

ilDBInterface	$db

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilECSParticipantSetting::__construct	(	int	$a_server_id,
		int	$mid
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ areIncomingLocalAccountsSupported()

ilECSParticipantSetting::areIncomingLocalAccountsSupported ( )

Definition at line 214 of file class.ilECSParticipantSetting.php.

References $incoming_local_accounts.

Referenced by create(), and update().

                                                        : bool
     {
         return $this->incoming_local_accounts;
     }

Here is the caller graph for this function:

◆ create()

ilECSParticipantSetting::create ( )

private

Definition at line 326 of file class.ilECSParticipantSetting.php.

References areIncomingLocalAccountsSupported(), getCommunityName(), getExportTypes(), getImportType(), getImportTypes(), getIncomingAuthType(), getMid(), getOutgoingAuthModes(), getOutgoingUsernamePlaceholders(), getServerId(), getTitle(), isExportEnabled(), isImportEnabled(), isTokenEnabled(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by update().

                              : bool
     {
         $query = 'INSERT INTO ecs_part_settings ' .
             '(sid,mid,export,import,import_type,title,cname,token,export_types, import_types, username_placeholders, incoming_auth_type, incoming_local_accounts, outgoing_auth_modes) ' .
             'VALUES( ' .
             $this->db->quote($this->getServerId(), 'integer') . ', ' .
             $this->db->quote($this->getMid(), 'integer') . ', ' .
             $this->db->quote((int) $this->isExportEnabled(), 'integer') . ', ' .
             $this->db->quote((int) $this->isImportEnabled(), 'integer') . ', ' .
             $this->db->quote($this->getImportType(), 'integer') . ', ' .
             $this->db->quote($this->getTitle(), 'text') . ', ' .
             $this->db->quote($this->getCommunityName(), 'text') . ', ' .
             $this->db->quote($this->isTokenEnabled(), 'integer') . ', ' .
             $this->db->quote(serialize($this->getExportTypes()), 'text') . ', ' .
             $this->db->quote(serialize($this->getImportTypes()), 'text') . ', ' .
             $this->db->quote(serialize($this->getOutgoingUsernamePlaceholders()), ilDBConstants::T_TEXT) . ', ' .
             $this->db->quote($this->areIncomingLocalAccountsSupported(), ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($this->getIncomingAuthType(), ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote(serialize($this->getOutgoingAuthModes()), ilDBConstants::T_TEXT) . ' ' .
             ')';
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilECSParticipantSetting::delete ( )

Delete one participant entry.

Definition at line 353 of file class.ilECSParticipantSetting.php.

References getMid(), and getServerId().

Referenced by ilECSSettingsGUI\refreshParticipants().

                             : bool
     {
         $query = 'DELETE FROM ecs_part_settings ' .
             'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
             'AND mid = ' . $this->db->quote($this->getMid(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableExport()

ilECSParticipantSetting::enableExport ( bool $a_status )

Definition at line 127 of file class.ilECSParticipantSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ enableImport()

ilECSParticipantSetting::enableImport ( bool $a_status )

Definition at line 137 of file class.ilECSParticipantSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ enableIncomingLocalAccounts()

ilECSParticipantSetting::enableIncomingLocalAccounts ( bool $a_status )

Definition at line 219 of file class.ilECSParticipantSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ enableToken()

ilECSParticipantSetting::enableToken ( bool $a_stat )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ exists()

ilECSParticipantSetting::exists ( )

private

Definition at line 273 of file class.ilECSParticipantSetting.php.

References $exists.

Referenced by read(), and update().

                              : bool
     {
         return $this->exists;
     }

Here is the caller graph for this function:

◆ getCommunityName()

ilECSParticipantSetting::getCommunityName ( )

Definition at line 169 of file class.ilECSParticipantSetting.php.

References $cname.

Referenced by create(), and update().

                                       : string
     {
         return $this->cname;
     }

Here is the caller graph for this function:

◆ getExportTypes()

ilECSParticipantSetting::getExportTypes ( )

Definition at line 194 of file class.ilECSParticipantSetting.php.

References $export_types.

Referenced by create(), and update().

                                     : array
     {
         return $this->export_types;
     }

Here is the caller graph for this function:

◆ getImportType()

ilECSParticipantSetting::getImportType ( )

Definition at line 154 of file class.ilECSParticipantSetting.php.

References $import_type.

Referenced by create(), and update().

                                    : int
     {
         return $this->import_type;
     }

Here is the caller graph for this function:

◆ getImportTypes()

ilECSParticipantSetting::getImportTypes ( )

Definition at line 268 of file class.ilECSParticipantSetting.php.

References $import_types.

Referenced by create(), and update().

                                     : array
     {
         return $this->import_types;
     }

Here is the caller graph for this function:

◆ getIncomingAuthType()

ilECSParticipantSetting::getIncomingAuthType ( )

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

References $incoming_auth_type.

Referenced by create(), and update().

                                          : int
     {
         return $this->incoming_auth_type;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilECSParticipantSetting::getInstance	(	int	$a_server_id,
		int	$mid
	)

static

Get instance by server id and mid.

Parameters

int	$a_server_id
int	$mid

Returns: ilECSParticipantSetting

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

References $mid.

Referenced by ilECSCmsCourseMemberCommandQueueHandler\checkAllocationActivation(), ilECSCmsCourseCommandQueueHandler\checkAllocationActivation(), ilRemoteObjectBase\getFullRemoteLink(), and ilECSAppEventListener\handleNewAccountCreation().

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

Here is the caller graph for this function:

◆ getMid()

ilECSParticipantSetting::getMid ( )

Definition at line 122 of file class.ilECSParticipantSetting.php.

References $mid.

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

                             : int
     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getOutgoingAuthModes()

ilECSParticipantSetting::getOutgoingAuthModes ( )

Definition at line 239 of file class.ilECSParticipantSetting.php.

References $outgoing_auth_modes.

Referenced by create(), getOutgoingExternalAuthModes(), isOutgoingAuthModeEnabled(), update(), and validate().

                                           : array
     {
         return $this->outgoing_auth_modes;
     }

Here is the caller graph for this function:

◆ getOutgoingExternalAuthModes()

ilECSParticipantSetting::getOutgoingExternalAuthModes ( )

Returns: string[]

Definition at line 247 of file class.ilECSParticipantSetting.php.

References getOutgoingAuthModes().

Referenced by ilECSUser\toGET().

                                                   : array
     {
         return array_filter(
             $this->getOutgoingAuthModes(),
             static function (string $auth_mode): bool {
                 return $auth_mode !== self::OUTGOING_AUTH_MODE_DEFAULT;
             }
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOutgoingUsernamePlaceholderByAuthMode()

ilECSParticipantSetting::getOutgoingUsernamePlaceholderByAuthMode ( string $auth_mode )

Definition at line 209 of file class.ilECSParticipantSetting.php.

References getOutgoingUsernamePlaceholders().

Referenced by ilECSUser\toGET(), and validate().

                                                                                : string
     {
         return $this->getOutgoingUsernamePlaceholders()[$auth_mode] ?? '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOutgoingUsernamePlaceholders()

ilECSParticipantSetting::getOutgoingUsernamePlaceholders ( )

Definition at line 199 of file class.ilECSParticipantSetting.php.

References $username_placeholders.

Referenced by create(), getOutgoingUsernamePlaceholderByAuthMode(), and update().

                                                      : array
     {
         return $this->username_placeholders;
     }

Here is the caller graph for this function:

◆ getServerId()

ilECSParticipantSetting::getServerId ( )

Get server id.

Definition at line 112 of file class.ilECSParticipantSetting.php.

References $server_id.

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

                                  : int
     {
         return $this->server_id;
     }

Here is the caller graph for this function:

◆ getTitle()

ilECSParticipantSetting::getTitle ( )

Definition at line 164 of file class.ilECSParticipantSetting.php.

References $title.

Referenced by create(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ isExportEnabled()

ilECSParticipantSetting::isExportEnabled ( )

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

References $export.

Referenced by create(), and update().

                                      : bool
     {
         return $this->export;
     }

Here is the caller graph for this function:

◆ isImportEnabled()

ilECSParticipantSetting::isImportEnabled ( )

Definition at line 142 of file class.ilECSParticipantSetting.php.

References $import.

Referenced by create(), and update().

                                      : bool
     {
         return $this->import;
     }

Here is the caller graph for this function:

◆ isOutgoingAuthModeEnabled()

ilECSParticipantSetting::isOutgoingAuthModeEnabled ( string $auth_mode )

Definition at line 257 of file class.ilECSParticipantSetting.php.

References getOutgoingAuthModes().

                                                                 : bool
     {
         return (bool) ($this->getOutgoingAuthModes()[$auth_mode] ?? false);
     }

Here is the call graph for this function:

◆ isTokenEnabled()

ilECSParticipantSetting::isTokenEnabled ( )

Definition at line 179 of file class.ilECSParticipantSetting.php.

References $token.

Referenced by create(), and update().

                                     : bool
     {
         return $this->token;
     }

Here is the caller graph for this function:

◆ read()

ilECSParticipantSetting::read ( )

private

Read stored entry.

Definition at line 365 of file class.ilECSParticipantSetting.php.

References $res, enableExport(), enableImport(), enableIncomingLocalAccounts(), enableToken(), exists(), ilDBConstants\FETCHMODE_OBJECT, getMid(), getServerId(), setCommunityName(), setExportTypes(), setImportType(), setImportTypes(), setIncomingAuthType(), setOutgoingAuthModes(), setOutgoingUsernamePlaceholders(), and setTitle().

Referenced by __construct().

                            : void
     {
         $query = 'SELECT * FROM ecs_part_settings ' .
             'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
             'AND mid = ' . $this->db->quote($this->getMid(), 'integer');
 
         $res = $this->db->query($query);
 
         $this->exists = ($res->numRows() ? true : false);
 
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->enableExport((bool) $row->export);
             $this->enableImport((bool) $row->import);
             $this->setImportType((int) $row->import_type);
             $this->setTitle($row->title);
             $this->setCommunityName($row->cname);
             $this->enableToken((bool) $row->token);
             $this->setExportTypes((array) unserialize($row->export_types, ['allowed_classes' => true]));
             $this->setImportTypes((array) unserialize($row->import_types, ['allowed_classes' => true]));
             $this->setOutgoingUsernamePlaceholders((array) unserialize((string) $row->username_placeholders, ['allowed_classes' => true]));
             $this->setIncomingAuthType((int) $row->incoming_auth_type);
             $this->enableIncomingLocalAccounts((bool) $row->incoming_local_accounts);
             $this->setOutgoingAuthModes((array) unserialize((string) $row->outgoing_auth_modes, ['allowed_classes' => true]));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCommunityName()

ilECSParticipantSetting::setCommunityName ( string $a_name )

Definition at line 174 of file class.ilECSParticipantSetting.php.

Referenced by read().

                                                     : void
     {
         $this->cname = $a_name;
     }

Here is the caller graph for this function:

◆ setExportTypes()

ilECSParticipantSetting::setExportTypes ( array $a_types )

Definition at line 189 of file class.ilECSParticipantSetting.php.

Referenced by read().

                                                   : void
     {
         $this->export_types = $a_types;
     }

Here is the caller graph for this function:

◆ setImportType()

ilECSParticipantSetting::setImportType ( int $a_type )

Definition at line 147 of file class.ilECSParticipantSetting.php.

Referenced by read().

                                               : void
     {
         if ($a_type !== self::IMPORT_UNCHANGED) {
             $this->import_type = $a_type;
         }
     }

Here is the caller graph for this function:

◆ setImportTypes()

ilECSParticipantSetting::setImportTypes ( array $a_types )

Definition at line 263 of file class.ilECSParticipantSetting.php.

Referenced by read().

                                                   : void
     {
         $this->import_types = $a_types;
     }

Here is the caller graph for this function:

◆ setIncomingAuthType()

ilECSParticipantSetting::setIncomingAuthType ( int $incoming_auth_type )

Definition at line 224 of file class.ilECSParticipantSetting.php.

References $incoming_auth_type.

Referenced by read().

                                                                 : void
     {
         $this->incoming_auth_type = $incoming_auth_type;
     }

Here is the caller graph for this function:

◆ setMid()

ilECSParticipantSetting::setMid ( int $a_mid )

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

                                       : void
     {
         $this->mid = $a_mid;
     }

◆ setOutgoingAuthModes()

ilECSParticipantSetting::setOutgoingAuthModes ( array $auth_modes )

Definition at line 234 of file class.ilECSParticipantSetting.php.

Referenced by read().

                                                            : void
     {
         $this->outgoing_auth_modes = $auth_modes;
     }

Here is the caller graph for this function:

◆ setOutgoingUsernamePlaceholders()

ilECSParticipantSetting::setOutgoingUsernamePlaceholders ( array $a_username_placeholders )

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

Referenced by read().

                                                                                    : void
     {
         $this->username_placeholders = $a_username_placeholders;
     }

Here is the caller graph for this function:

◆ setTitle()

ilECSParticipantSetting::setTitle ( string $a_title )

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

Referenced by read().

                                              : void
     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ update()

ilECSParticipantSetting::update ( )

Update Calls create automatically when no entry exists.

Definition at line 299 of file class.ilECSParticipantSetting.php.

References areIncomingLocalAccountsSupported(), create(), exists(), getCommunityName(), getExportTypes(), getImportType(), getImportTypes(), getIncomingAuthType(), getMid(), getOutgoingAuthModes(), getOutgoingUsernamePlaceholders(), getServerId(), getTitle(), isExportEnabled(), isImportEnabled(), isTokenEnabled(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                             : bool
     {
         if (!$this->exists()) {
             return $this->create();
         }
         $query = 'UPDATE ecs_part_settings ' .
             'SET ' .
             'sid = ' . $this->db->quote($this->getServerId(), 'integer') . ', ' .
             'mid = ' . $this->db->quote($this->getMid(), 'integer') . ', ' .
             'export = ' . $this->db->quote((int) $this->isExportEnabled(), 'integer') . ', ' .
             'import = ' . $this->db->quote((int) $this->isImportEnabled(), 'integer') . ', ' .
             'import_type = ' . $this->db->quote($this->getImportType(), 'integer') . ', ' .
             'title = ' . $this->db->quote($this->getTitle(), 'text') . ', ' .
             'cname = ' . $this->db->quote($this->getCommunityName(), 'text') . ', ' .
             'token = ' . $this->db->quote($this->isTokenEnabled(), 'integer') . ', ' .
             'export_types = ' . $this->db->quote(serialize($this->getExportTypes()), 'text') . ', ' .
             'import_types = ' . $this->db->quote(serialize($this->getImportTypes()), ilDBConstants::T_TEXT) . ', ' .
             'username_placeholders = ' . $this->db->quote(serialize($this->getOutgoingUsernamePlaceholders()), ilDBConstants::T_TEXT) . ', ' .
             'incoming_local_accounts = ' . $this->db->quote($this->areIncomingLocalAccountsSupported(), ilDBConstants::T_INTEGER) . ', ' .
             'incoming_auth_type = ' . $this->db->quote($this->getIncomingAuthType(), ilDBConstants::T_INTEGER) . ', ' .
             'outgoing_auth_modes = ' . $this->db->quote(serialize($this->getOutgoingAuthModes()), ilDBConstants::T_TEXT) . ' ' .
             'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ' .
             'AND mid  = ' . $this->db->quote($this->getMid(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilECSParticipantSetting::validate ( )

Definition at line 278 of file class.ilECSParticipantSetting.php.

References getOutgoingAuthModes(), and getOutgoingUsernamePlaceholderByAuthMode().

                               : int
     {
         foreach ($this->getOutgoingAuthModes() as $auth_mode) {
             if ($auth_mode === self::OUTGOING_AUTH_MODE_DEFAULT) {
                 continue;
             }
             $placeholder = $this->getOutgoingUsernamePlaceholderByAuthMode($auth_mode);
             if (
                 !stristr($placeholder, self::LOGIN_PLACEHOLDER) &&
                 !stristr($placeholder, self::EXTERNAL_ACCOUNT_PLACEHOLDER)
             ) {
                 return self::ERR_MISSING_USERNAME_PLACEHOLDER;
             }
         }
         return self::VALIDATION_OK;
     }

Here is the call graph for this function:

Field Documentation

◆ $auth_version

int ilECSParticipantSetting::$auth_version = self::AUTH_VERSION_4

private

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

◆ $cname

string ilECSParticipantSetting::$cname = ''

private

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

Referenced by getCommunityName().

◆ $db

ilDBInterface ilECSParticipantSetting::$db

private

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

◆ $dtoken

bool ilECSParticipantSetting::$dtoken = true

private

Definition at line 63 of file class.ilECSParticipantSetting.php.

◆ $exists

bool ilECSParticipantSetting::$exists = false

private

Definition at line 79 of file class.ilECSParticipantSetting.php.

Referenced by exists().

◆ $export

bool ilECSParticipantSetting::$export = false

private

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

Referenced by isExportEnabled().

◆ $export_types

array ilECSParticipantSetting::$export_types = array()

private

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

Referenced by getExportTypes().

◆ $import

bool ilECSParticipantSetting::$import = false

private

Definition at line 58 of file class.ilECSParticipantSetting.php.

Referenced by isImportEnabled().

◆ $import_type

int ilECSParticipantSetting::$import_type = 1

private

Definition at line 59 of file class.ilECSParticipantSetting.php.

Referenced by getImportType().

◆ $import_types

array ilECSParticipantSetting::$import_types = array()

private

Definition at line 70 of file class.ilECSParticipantSetting.php.

Referenced by getImportTypes().

◆ $incoming_auth_type

int ilECSParticipantSetting::$incoming_auth_type = self::INCOMING_AUTH_TYPE_INACTIVE

private

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

Referenced by getIncomingAuthType(), and setIncomingAuthType().

◆ $incoming_local_accounts

bool ilECSParticipantSetting::$incoming_local_accounts = true

private

Definition at line 72 of file class.ilECSParticipantSetting.php.

Referenced by areIncomingLocalAccountsSupported().

◆ $instances

array ilECSParticipantSetting::$instances = []

staticprotected

Definition at line 46 of file class.ilECSParticipantSetting.php.

◆ $mid

int ilECSParticipantSetting::$mid

private

Definition at line 56 of file class.ilECSParticipantSetting.php.

Referenced by __construct(), getInstance(), and getMid().

◆ $outgoing_auth_modes

array ilECSParticipantSetting::$outgoing_auth_modes = []

private

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

Referenced by getOutgoingAuthModes().

◆ $person_type

int ilECSParticipantSetting::$person_type = self::PERSON_UID

private

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

◆ $server_id

int ilECSParticipantSetting::$server_id

private

Definition at line 55 of file class.ilECSParticipantSetting.php.

Referenced by getServerId().

◆ $title

string ilECSParticipantSetting::$title = ''

private

Definition at line 60 of file class.ilECSParticipantSetting.php.

Referenced by getTitle().

◆ $token

bool ilECSParticipantSetting::$token = true

private

Definition at line 62 of file class.ilECSParticipantSetting.php.

Referenced by isTokenEnabled().

◆ $username_placeholders

array ilECSParticipantSetting::$username_placeholders = []

private

Definition at line 71 of file class.ilECSParticipantSetting.php.

Referenced by getOutgoingUsernamePlaceholders().

◆ AUTH_VERSION_4

const ilECSParticipantSetting::AUTH_VERSION_4 = 1

Definition at line 25 of file class.ilECSParticipantSetting.php.

◆ AUTH_VERSION_5

const ilECSParticipantSetting::AUTH_VERSION_5 = 2

Definition at line 26 of file class.ilECSParticipantSetting.php.

◆ ERR_MISSING_USERNAME_PLACEHOLDER

const ilECSParticipantSetting::ERR_MISSING_USERNAME_PLACEHOLDER = 1

Definition at line 43 of file class.ilECSParticipantSetting.php.

Referenced by ilECSParticipantSettingsGUI\saveSettings().

◆ EXTERNAL_ACCOUNT_PLACEHOLDER

const ilECSParticipantSetting::EXTERNAL_ACCOUNT_PLACEHOLDER = '[EXTERNAL_ACCOUNT]'

Definition at line 34 of file class.ilECSParticipantSetting.php.

Referenced by ilECSUser\toGET().

◆ IMPORT_CMS

const ilECSParticipantSetting::IMPORT_CMS = 3

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

Referenced by ilECSCommunityTableGUI\fillRow(), ilECSParticipantSettings\lookupCmsMid(), and ilECSSettingsGUI\validateImportTypes().

◆ IMPORT_CRS

const ilECSParticipantSetting::IMPORT_CRS = 2

Definition at line 52 of file class.ilECSParticipantSetting.php.

Referenced by ilECSCommunityTableGUI\fillRow().

◆ IMPORT_RCRS

const ilECSParticipantSetting::IMPORT_RCRS = 1

Definition at line 51 of file class.ilECSParticipantSetting.php.

Referenced by ilECSCommunityTableGUI\fillRow().

◆ IMPORT_UNCHANGED

const ilECSParticipantSetting::IMPORT_UNCHANGED = 0

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

Referenced by ilECSSettingsGUI\validateImportTypes().

◆ INCOMING_AUTH_TYPE_INACTIVE

const ilECSParticipantSetting::INCOMING_AUTH_TYPE_INACTIVE = 0

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

Referenced by ilECSParticipantSettingsGUI\initFormSettings().

◆ INCOMING_AUTH_TYPE_LOGIN_PAGE

const ilECSParticipantSetting::INCOMING_AUTH_TYPE_LOGIN_PAGE = 1

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

Referenced by ilAuthProviderECS\handleLoginByAuthMode(), ilECSAppEventListener\handleNewAccountCreation(), and ilECSParticipantSettingsGUI\initFormSettings().

◆ INCOMING_AUTH_TYPE_SHIBBOLETH

const ilECSParticipantSetting::INCOMING_AUTH_TYPE_SHIBBOLETH = 2

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

Referenced by ilAuthProviderECS\handleLoginByAuthMode(), ilECSAppEventListener\handleNewAccountCreation(), and ilECSParticipantSettingsGUI\initFormSettings().

◆ LOGIN_PLACEHOLDER

const ilECSParticipantSetting::LOGIN_PLACEHOLDER = '[LOGIN]'

Definition at line 33 of file class.ilECSParticipantSetting.php.

Referenced by ilECSUser\toGET().

◆ OUTGOING_AUTH_MODE_DEFAULT

const ilECSParticipantSetting::OUTGOING_AUTH_MODE_DEFAULT = 'default'

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

◆ PERSON_EPPN

const ilECSParticipantSetting::PERSON_EPPN = 1

Definition at line 28 of file class.ilECSParticipantSetting.php.

◆ PERSON_LOGIN

const ilECSParticipantSetting::PERSON_LOGIN = 3

Definition at line 30 of file class.ilECSParticipantSetting.php.

◆ PERSON_LUID

const ilECSParticipantSetting::PERSON_LUID = 2

Definition at line 29 of file class.ilECSParticipantSetting.php.

◆ PERSON_UID

const ilECSParticipantSetting::PERSON_UID = 4

Definition at line 31 of file class.ilECSParticipantSetting.php.

◆ VALIDATION_OK

const ilECSParticipantSetting::VALIDATION_OK = 0

Definition at line 42 of file class.ilECSParticipantSetting.php.

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

Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areIncomingLocalAccountsSupported()

◆ create()

◆ delete()

◆ enableExport()

◆ enableImport()

◆ enableIncomingLocalAccounts()

◆ enableToken()

◆ exists()

◆ getCommunityName()

◆ getExportTypes()

◆ getImportType()

◆ getImportTypes()

◆ getIncomingAuthType()

◆ getInstance()

◆ getMid()

◆ getOutgoingAuthModes()

◆ getOutgoingExternalAuthModes()

◆ getOutgoingUsernamePlaceholderByAuthMode()

◆ getOutgoingUsernamePlaceholders()

◆ getServerId()

◆ getTitle()

◆ isExportEnabled()

◆ isImportEnabled()

◆ isOutgoingAuthModeEnabled()

◆ isTokenEnabled()

◆ read()

◆ setCommunityName()

◆ setExportTypes()

◆ setImportType()

◆ setImportTypes()

◆ setIncomingAuthType()

◆ setMid()

◆ setOutgoingAuthModes()

◆ setOutgoingUsernamePlaceholders()

◆ setTitle()

◆ update()

◆ validate()

Field Documentation

◆ $auth_version

◆ $cname

◆ $db

◆ $dtoken

◆ $exists

◆ $export

◆ $export_types

◆ $import

◆ $import_type

◆ $import_types

◆ $incoming_auth_type

◆ $incoming_local_accounts

◆ $instances

◆ $mid

◆ $outgoing_auth_modes

◆ $person_type

◆ $server_id

◆ $title

◆ $token

◆ $username_placeholders

◆ AUTH_VERSION_4

◆ AUTH_VERSION_5

◆ ERR_MISSING_USERNAME_PLACEHOLDER

◆ EXTERNAL_ACCOUNT_PLACEHOLDER

◆ IMPORT_CMS

◆ IMPORT_CRS

◆ IMPORT_RCRS

◆ IMPORT_UNCHANGED

◆ INCOMING_AUTH_TYPE_INACTIVE

◆ INCOMING_AUTH_TYPE_LOGIN_PAGE

◆ INCOMING_AUTH_TYPE_SHIBBOLETH

◆ LOGIN_PLACEHOLDER