This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilStudyProgrammeAutoMembershipSource:

Public Member Functions
	__construct (int $prg_obj_id, string $source_type, int $source_id, bool $enabled, int $last_edited_usr_id, DateTimeImmutable $last_edited)

	getPrgObjId ()

	getSourceType ()

	getSourceId ()

	isEnabled ()

	getLastEditorId ()

	getLastEdited ()

Data Fields
const	TYPE_ROLE = 'role'

const	TYPE_GROUP = 'grp'

const	TYPE_COURSE = 'crs'

const	TYPE_ORGU = 'orgu'

const	SOURCE_MAPPING

Protected Attributes
int	$prg_obj_id

string	$source_type

int	$source_id

bool	$enabled

int	$last_edited_usr_id

DateTimeImmutable	$last_edited

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilStudyProgrammeAutoMembershipSource

Author: : Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAutoMembershipSource::__construct	(	int	$prg_obj_id,
		string	$source_type,
		int	$source_id,
		bool	$enabled,
		int	$last_edited_usr_id,
		DateTimeImmutable	$last_edited
	)

Definition at line 47 of file class.ilStudyProgrammeAutoMembershipSource.php.

References $enabled, $last_edited, $last_edited_usr_id, $prg_obj_id, $source_id, and $source_type.

       {
         if (!in_array($source_type, [
             self::TYPE_ROLE,
             self::TYPE_GROUP,
             self::TYPE_COURSE,
             self::TYPE_ORGU
         ])) {
             throw new InvalidArgumentException("Invalid source-type: " . $source_type, 1);
         }
 
         $this->prg_obj_id = $prg_obj_id;
         $this->source_type = $source_type;
         $this->source_id = $source_id;
         $this->enabled = $enabled;
         $this->last_edited_usr_id = $last_edited_usr_id;
         $this->last_edited = $last_edited;
     }

Member Function Documentation

◆ getLastEdited()

ilStudyProgrammeAutoMembershipSource::getLastEdited ( )

Definition at line 97 of file class.ilStudyProgrammeAutoMembershipSource.php.

References $last_edited.

Referenced by ilStudyProgrammeAutoMembershipsSourceTest\testGetLastEdited().

                                    : DateTimeImmutable
     {
         return $this->last_edited;
     }

Here is the caller graph for this function:

◆ getLastEditorId()

ilStudyProgrammeAutoMembershipSource::getLastEditorId ( )

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

References $last_edited_usr_id.

Referenced by ilStudyProgrammeAutoMembershipsSourceTest\testGetLastEditorId().

                                      : int
     {
         return $this->last_edited_usr_id;
     }

Here is the caller graph for this function:

◆ getPrgObjId()

ilStudyProgrammeAutoMembershipSource::getPrgObjId ( )

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

References $prg_obj_id.

Referenced by ilStudyProgrammeAutoMembershipsSourceTest\testGetPrgObjId(), and ilStudyProgrammeAutoMembershipsDBRepository\update().

                                  : int
     {
         return $this->prg_obj_id;
     }

Here is the caller graph for this function:

◆ getSourceId()

ilStudyProgrammeAutoMembershipSource::getSourceId ( )

Definition at line 82 of file class.ilStudyProgrammeAutoMembershipSource.php.

References $source_id.

Referenced by ilObjStudyProgramme\getApplicableMembershipSourceForUser(), ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), ilStudyProgrammeAutoMembershipsSourceTest\testGetSourceId(), and ilStudyProgrammeAutoMembershipsDBRepository\update().

                                  : int
     {
         return $this->source_id;
     }

Here is the caller graph for this function:

◆ getSourceType()

ilStudyProgrammeAutoMembershipSource::getSourceType ( )

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

References $source_type.

Referenced by ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), ilStudyProgrammeAutoMembershipsSourceTest\testGetSourceType(), and ilStudyProgrammeAutoMembershipsDBRepository\update().

                                    : string
     {
         return $this->source_type;
     }

Here is the caller graph for this function:

◆ isEnabled()

ilStudyProgrammeAutoMembershipSource::isEnabled ( )

Definition at line 87 of file class.ilStudyProgrammeAutoMembershipSource.php.

References $enabled.

Referenced by ilStudyProgrammeAutoMembershipsDBRepository\update().

                                : bool
     {
         return $this->enabled;
     }

Here is the caller graph for this function:

Field Documentation

◆ $enabled

bool ilStudyProgrammeAutoMembershipSource::$enabled

protected

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

Referenced by __construct(), and isEnabled().

◆ $last_edited

DateTimeImmutable ilStudyProgrammeAutoMembershipSource::$last_edited

protected

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

Referenced by __construct(), and getLastEdited().

◆ $last_edited_usr_id

int ilStudyProgrammeAutoMembershipSource::$last_edited_usr_id

protected

Definition at line 44 of file class.ilStudyProgrammeAutoMembershipSource.php.

Referenced by __construct(), and getLastEditorId().

◆ $prg_obj_id

int ilStudyProgrammeAutoMembershipSource::$prg_obj_id

protected

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

Referenced by __construct(), and getPrgObjId().

◆ $source_id

int ilStudyProgrammeAutoMembershipSource::$source_id

protected

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

Referenced by __construct(), and getSourceId().

◆ $source_type

string ilStudyProgrammeAutoMembershipSource::$source_type

protected

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

Referenced by __construct(), and getSourceType().

◆ SOURCE_MAPPING

const ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING

Initial value:

= [

self::TYPE_ROLE => ilPRGAssignment::AUTO_ASSIGNED_BY_ROLE

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

Referenced by ilObjStudyProgramme\addMemberToProgrammes(), ilStudyProgrammeUserTable\assignmentSourceToRepresent(), ilObjStudyProgramme\enableAutomaticMembershipSource(), and ilObjStudyProgramme\removeMemberFromProgrammes().

◆ TYPE_COURSE

const ilStudyProgrammeAutoMembershipSource::TYPE_COURSE = 'crs'

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

Referenced by ilStudyProgrammeAppEventListener\addMemberToProgrammes(), ilObjStudyProgrammeAutoMembershipsGUI\getForm(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), ilStudyProgrammeAppEventListener\handleEvent(), and ilStudyProgrammeAppEventListener\removeMemberFromProgrammes().

◆ TYPE_GROUP

const ilStudyProgrammeAutoMembershipSource::TYPE_GROUP = 'grp'

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

Referenced by ilStudyProgrammeAppEventListener\addMemberToProgrammes(), ilObjStudyProgrammeAutoMembershipsGUI\getForm(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), ilStudyProgrammeAppEventListener\handleEvent(), and ilStudyProgrammeAppEventListener\removeMemberFromProgrammes().

◆ TYPE_ORGU

const ilStudyProgrammeAutoMembershipSource::TYPE_ORGU = 'orgu'

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

Referenced by ilObjStudyProgrammeAutoMembershipsGUI\getAsynchModalOutput(), ilObjStudyProgrammeAutoMembershipsGUI\getForm(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), and ilStudyProgrammeAppEventListener\handleEvent().

◆ TYPE_ROLE

const ilStudyProgrammeAutoMembershipSource::TYPE_ROLE = 'role'

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

Referenced by ilStudyProgrammeAppEventListener\addMemberToProgrammes(), ilObjStudyProgrammeAutoMembershipsGUI\getForm(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilObjStudyProgrammeAutoMembershipsGUI\getTitleRepresentation(), ilStudyProgrammeAppEventListener\handleEvent(), ilStudyProgrammeAppEventListener\removeMemberFromProgrammes(), and ilStudyProgrammeAutoMembershipsSourceTest\setUp().

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

Modules/StudyProgramme/classes/model/AutoMemberships/class.ilStudyProgrammeAutoMembershipSource.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getLastEdited()

◆ getLastEditorId()

◆ getPrgObjId()

◆ getSourceId()

◆ getSourceType()

◆ isEnabled()

Field Documentation

◆ $enabled

◆ $last_edited

◆ $last_edited_usr_id

◆ $prg_obj_id

◆ $source_id

◆ $source_type

◆ SOURCE_MAPPING

◆ TYPE_COURSE

◆ TYPE_GROUP

◆ TYPE_ORGU

◆ TYPE_ROLE