Class ilStudyProgrammeAutoMembershipSource. More...

Collaboration diagram for ilStudyProgrammeAutoMembershipSource:

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

	getPrgObjId ()

	getSourceType ()

	getSourceId ()

	isEnabled ()

	getLastEditorId ()

	getLastEdited ()

	isSearchRecursive ()

Data Fields
const	TYPE_ROLE = 'role'

const	TYPE_GROUP = 'grp'

const	TYPE_COURSE = 'crs'

const	TYPE_ORGU = 'orgu'

const	SOURCE_MAPPING

Detailed Description

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	(	protected int	$prg_obj_id,
		protected string	$source_type,
		protected int	$source_id,
		protected bool	$enabled,
		protected int	$last_edited_usr_id,
		protected DateTimeImmutable	$last_edited,
		protected bool	$search_recursive
	)

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

      {
        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);
        }
    }

Member Function Documentation

◆ getLastEdited()

ilStudyProgrammeAutoMembershipSource::getLastEdited ( )

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

                                   : DateTimeImmutable
    {
        return $this->last_edited;
    }

Referenced by ilStudyProgrammeAutoMembershipsSourceTest\testGetLastEdited().

Here is the caller graph for this function:

◆ getLastEditorId()

ilStudyProgrammeAutoMembershipSource::getLastEditorId ( )

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

                                     : int
    {
        return $this->last_edited_usr_id;
    }

Referenced by ilStudyProgrammeAutoMembershipsSourceTest\testGetLastEditorId().

Here is the caller graph for this function:

◆ getPrgObjId()

ilStudyProgrammeAutoMembershipSource::getPrgObjId ( )

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

                                 : int
    {
        return $this->prg_obj_id;
    }

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

Here is the caller graph for this function:

◆ getSourceId()

ilStudyProgrammeAutoMembershipSource::getSourceId ( )

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

                                 : int
    {
        return $this->source_id;
    }

Referenced by ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilStudyProgrammeAutoMembershipsSourceTest\testGetSourceId(), and ilStudyProgrammeAutoMembershipsDBRepository\update().

Here is the caller graph for this function:

◆ getSourceType()

ilStudyProgrammeAutoMembershipSource::getSourceType ( )

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

                                   : string
    {
        return $this->source_type;
    }

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

Here is the caller graph for this function:

◆ isEnabled()

ilStudyProgrammeAutoMembershipSource::isEnabled ( )

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

                               : bool
    {
        return $this->enabled;
    }

Referenced by ilStudyProgrammeAutoMembershipsDBRepository\update().

Here is the caller graph for this function:

◆ isSearchRecursive()

ilStudyProgrammeAutoMembershipSource::isSearchRecursive ( )

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

                                       : bool
    {
        return $this->search_recursive;
    }

Referenced by ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), and ilStudyProgrammeAutoMembershipsDBRepository\update().

Here is the caller graph for this function:

Field Documentation

◆ SOURCE_MAPPING

const ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING

Initial value:

= [
        self::TYPE_ROLE => ilPRGAssignment::AUTO_ASSIGNED_BY_ROLE,
        self::TYPE_GROUP => ilPRGAssignment::AUTO_ASSIGNED_BY_GROUP,
        self::TYPE_COURSE => ilPRGAssignment::AUTO_ASSIGNED_BY_COURSE,
        self::TYPE_ORGU => ilPRGAssignment::AUTO_ASSIGNED_BY_ORGU
    ]