ILIAS\Survey\Participants\InvitationsManager Class Reference

Survey invitations. More...

Collaboration diagram for ILIAS\Survey\Participants\InvitationsManager:

Public Member Functions
	__construct (InvitationsDBRepository $repo=null, Execution\RunDBRepository $run_repo=null, Settings\SettingsDBRepository $set_repo=null)
	Constructor. More...
	remove (int $survey_id, int $user_id)
	Remove invitation. More...
	add (int $survey_id, int $user_id)
	Add invitation. More...
	getAllForSurvey (int $survey_id)
	Get invitations for survey. More...
	getOpenInvitationsOfUser (int $user_id)
	Get all open invitations of a user. More...

Protected Attributes
	$repo
	$run_repo
	$set_repo

Detailed Description

Survey invitations.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 15 of file class.InvitationsManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Participants\InvitationsManager::__construct	(	InvitationsDBRepository	$repo = null,
		Execution\RunDBRepository	$run_repo = null,
		Settings\SettingsDBRepository	$set_repo = null
	)

Constructor.

Definition at line 35 of file class.InvitationsManager.php.

      {
        $this->repo = (is_null($repo))
            ? new InvitationsDBRepository()
            : $repo;
 
        $this->run_repo = (is_null($run_repo))
            ? new Execution\RunDBRepository()
            : $run_repo;
 
        $this->set_repo = (is_null($set_repo))
            ? new Settings\SettingsDBRepository()
            : $set_repo;
    }

References ILIAS\Survey\Participants\InvitationsManager\$repo, ILIAS\Survey\Participants\InvitationsManager\$run_repo, and ILIAS\Survey\Participants\InvitationsManager\$set_repo.

Member Function Documentation

add()

ILIAS\Survey\Participants\InvitationsManager::add	(	int	$survey_id,
		int	$user_id
	)

Add invitation.

Parameters

int	$survey_id	Survey ID not object ID!
int	$user_id

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

    {
        $this->repo->add($survey_id, $user_id);
    }

getAllForSurvey()

ILIAS\Survey\Participants\InvitationsManager::getAllForSurvey

(

int

$survey_id

)

Get invitations for survey.

Parameters

int

$survey_id

Survey ID not object ID!

Returns

int[]

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

                                                    : array
    {
        return $this->repo->getAllForSurvey($survey_id);
    }

getOpenInvitationsOfUser()

ILIAS\Survey\Participants\InvitationsManager::getOpenInvitationsOfUser

(

int

$user_id

)

Get all open invitations of a user.

Parameters

return

Definition at line 94 of file class.InvitationsManager.php.

    {
        // get all invitations
        $survey_ids = $this->repo->getAllForUser($user_id);
 
        // check if user started already
        $finished_surveys = $this->run_repo->getFinishedSurveysOfUser($user_id);
 
        $open_surveys = array_filter($survey_ids, function ($i) use ($finished_surveys) {
            return !in_array($i, $finished_surveys);
        });
 
        // filter all surveys that have ended
        $has_ended = $this->set_repo->hasEnded($open_surveys);
        $open_surveys = array_filter($open_surveys, function ($i) use ($has_ended) {
            return !$has_ended[$i];
        });
 
        return $open_surveys;
    }

References $i.

remove()

ILIAS\Survey\Participants\InvitationsManager::remove	(	int	$survey_id,
		int	$user_id
	)

Remove invitation.

Parameters

int	$survey_id	Survey ID not object ID!
int	$user_id

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

    {
        $this->repo->remove($survey_id, $user_id);
    }

Field Documentation

$repo

ILIAS\Survey\Participants\InvitationsManager::$repo

protected

Definition at line 20 of file class.InvitationsManager.php.

Referenced by ILIAS\Survey\Participants\InvitationsManager\__construct().

$run_repo

ILIAS\Survey\Participants\InvitationsManager::$run_repo

protected

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

Referenced by ILIAS\Survey\Participants\InvitationsManager\__construct().

$set_repo

ILIAS\Survey\Participants\InvitationsManager::$set_repo

protected

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

Referenced by ILIAS\Survey\Participants\InvitationsManager\__construct().

---

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

• Modules/Survey/Participants/class.InvitationsManager.php