ilStudyProgrammeMembershipSourceReaderFactory Class Reference

Provides adapters to read member-ids from a specific source. More...

Collaboration diagram for ilStudyProgrammeMembershipSourceReaderFactory:

Public Member Functions
	__construct (Pimple\Container $dic)
	getReaderFor (ilStudyProgrammeAutoMembershipSource $ams, ?int $exclude_id)
	Build a MembershipSourceReader according to $src_type. More...

Protected Attributes
Pimple Container	$dic

Detailed Description

Provides adapters to read member-ids from a specific source.

Definition at line 24 of file class.ilStudyProgrammeMembershipSourceReaderFactory.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeMembershipSourceReaderFactory::__construct

(

Pimple\Container

$dic

)

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

References $dic.

    {
        $this->dic = $dic;
    }

Member Function Documentation

getReaderFor()

ilStudyProgrammeMembershipSourceReaderFactory::getReaderFor	(	ilStudyProgrammeAutoMembershipSource	$ams,
		?int	$exclude_id
	)

Build a MembershipSourceReader according to $src_type.

Exceptions

InvalidArgumentException

if $src_type is not one of the constant types in ilStudyProgrammeAutoMembershipSource.

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

References ilObjOrgUnitTree\_getInstance(), ilParticipants\getInstance(), ilStudyProgrammeAutoMembershipSource\getSourceId(), ilStudyProgrammeAutoMembershipSource\getSourceType(), ilStudyProgrammeAutoMembershipSource\isSearchRecursive(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, ilStudyProgrammeAutoMembershipSource\TYPE_ORGU, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

                                                                                             : ilStudyProgrammeMembershipSourceReader
    {
        $src_id = $ams->getSourceId();
        switch ($ams->getSourceType()) {
            case ilStudyProgrammeAutoMembershipSource::TYPE_ROLE:
                return new ilStudyProgrammeMembershipSourceReaderRole(
                    $this->dic['rbacreview'],
                    $src_id
                );
            case ilStudyProgrammeAutoMembershipSource::TYPE_GROUP:
            case ilStudyProgrammeAutoMembershipSource::TYPE_COURSE:
                return new ilStudyProgrammeMembershipSourceReaderParticipants(
                    ilParticipants::getInstance($src_id)
                );
            case ilStudyProgrammeAutoMembershipSource::TYPE_ORGU:
                return new ilStudyProgrammeMembershipSourceReaderOrgu(
                    ilObjOrgUnitTree::_getInstance(),
                    new ilOrgUnitUserAssignmentDBRepository($this->dic['ilDB'], $this->dic->event()),
                    $src_id,
                    $ams->isSearchRecursive(),
                    $exclude_id
                );

            default:
                throw new InvalidargumentException("Invalid source type.", 1);
        }
    }

Here is the call graph for this function:

Field Documentation

$dic

Pimple Container ilStudyProgrammeMembershipSourceReaderFactory::$dic

protected

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

Referenced by __construct().

---

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

• components/ILIAS/StudyProgramme/classes/model/AutoMemberships/class.ilStudyProgrammeMembershipSourceReaderFactory.php