ILIAS\Survey\Participants\StatusManager Class Reference

Participant status manager. More...

Collaboration diagram for ILIAS\Survey\Participants\StatusManager:

Public Member Functions
	__construct (InternalDomainService $domain_service, InternalRepoService $repo_service, \ilObjSurvey $survey, int $user_id)
	canAddItselfAsAppraisee ()
	Checks if a user can add himself as an appraisee. More...
	cantStartAgain ()
	This will return true, if a survey without appraisees is finished Note: Code will be gathered from session. More...
	canViewUserResults ()
	Can the current user see the own results. More...
	canMailUserResults ()
	Can the current user mail the confirmation. More...
	mustEnterCode (string $code="")
	Check if user must enter code to start (and currently is able to start) More...
	isExternalRater ()
	isAppraisee ()

Protected Attributes
ILIAS Survey Execution RunManager	$run_manager
InternalDomainService	$domain_service
ilObjSurvey	$survey
int	$user_id
ILIAS Survey Access AccessManager	$access
ILIAS Survey Mode FeatureConfig	$feature_config
InternalRepoService	$repo_service

Detailed Description

Participant status manager.

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Participants\StatusManager::__construct	(	InternalDomainService	$domain_service,
		InternalRepoService	$repo_service,
		\ilObjSurvey	$survey,
		int	$user_id
	)

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

References ILIAS\Survey\Participants\StatusManager\$domain_service, ILIAS\Survey\Participants\StatusManager\$repo_service, ILIAS\Survey\Participants\StatusManager\$survey, ILIAS\Survey\Participants\StatusManager\$user_id, ILIAS\Repository\access(), ILIAS\Survey\InternalDomainService\execution(), ilObjSurvey\getMode(), and ilObject\getRefId().

      {
        $this->domain_service = $domain_service;
        $this->repo_service = $repo_service;
        $this->access = $this->domain_service->access($survey->getRefId(), $user_id);
        //$this->anonymous_session_repo = $this->
        $this->feature_config = $this->domain_service->modeFeatureConfig($survey->getMode());
        $this->survey = $survey;
        $this->user_id = $user_id;
        $this->run_manager = $domain_service->execution()->run($survey, $user_id);
    }

Here is the call graph for this function:

Member Function Documentation

canAddItselfAsAppraisee()

ILIAS\Survey\Participants\StatusManager::canAddItselfAsAppraisee

(

)

Checks if a user can add himself as an appraisee.

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

References ILIAS\Survey\Participants\StatusManager\$access, ILIAS\Survey\Participants\StatusManager\$feature_config, ILIAS\Survey\Participants\StatusManager\$survey, ILIAS\Survey\Participants\StatusManager\$user_id, and ANONYMOUS_USER_ID.

                                             : bool
    {
        $survey = $this->survey;
        $user_id = $this->user_id;
        $access = $this->access;
        $feature_config = $this->feature_config;

        if ($access->canRead() &&
            $feature_config->usesAppraisees() &&
            $survey->get360SelfAppraisee() &&
            !$survey->isAppraisee($user_id) &&
            $user_id !== ANONYMOUS_USER_ID) {
            return true;
        }
        return false;
    }

canMailUserResults()

ILIAS\Survey\Participants\StatusManager::canMailUserResults

(

)

Can the current user mail the confirmation.

Returns

bool

Definition at line 118 of file class.StatusManager.php.

References ANONYMOUS_USER_ID, and ILIAS\Survey\Participants\StatusManager\cantStartAgain().

                                        : bool
    {
        if ($this->cantStartAgain() &&
            $this->user_id !== ANONYMOUS_USER_ID &&
            $this->survey->hasMailConfirmation()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

cantStartAgain()

ILIAS\Survey\Participants\StatusManager::cantStartAgain

(

)

This will return true, if a survey without appraisees is finished Note: Code will be gathered from session.

Returns

bool

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

References ILIAS\Survey\Participants\StatusManager\$feature_config.

Referenced by ILIAS\Survey\Participants\StatusManager\canMailUserResults(), and ILIAS\Survey\Participants\StatusManager\canViewUserResults().

                                    : bool
    {
        $feature_config = $this->feature_config;

        if ($feature_config->usesAppraisees()) {
            return false;
        }

        if ($this->run_manager->hasStarted() && $this->run_manager->hasFinished()) {
            // check for
            // !(!$this->object->isAccessibleWithoutCode() && !$anonymous_code && $ilUser->getId() == ANONYMOUS_USER_ID)
            // removed
            // not code accessible an no anonymous code and anonymous user (see #0020333)
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

canViewUserResults()

ILIAS\Survey\Participants\StatusManager::canViewUserResults

(

)

Can the current user see the own results.

Returns

bool

Definition at line 104 of file class.StatusManager.php.

References ANONYMOUS_USER_ID, and ILIAS\Survey\Participants\StatusManager\cantStartAgain().

                                        : bool
    {
        if ($this->cantStartAgain() &&
            $this->user_id !== ANONYMOUS_USER_ID &&
            $this->survey->hasViewOwnResults()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

isAppraisee()

ILIAS\Survey\Participants\StatusManager::isAppraisee

(

)

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

References ILIAS\Survey\Participants\StatusManager\$feature_config, and ILIAS\Survey\Participants\StatusManager\$survey.

Referenced by ILIAS\Survey\Participants\StatusManager\mustEnterCode().

                                 : bool
    {
        $survey = $this->survey;
        $feature_config = $this->feature_config;
        if ($feature_config->usesAppraisees() &&
            $survey->isAppraisee($this->user_id)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

isExternalRater()

ILIAS\Survey\Participants\StatusManager::isExternalRater

(

)

Definition at line 144 of file class.StatusManager.php.

References ILIAS\Survey\Participants\StatusManager\$feature_config, and ILIAS\Survey\Participants\StatusManager\$survey.

                                     : bool
    {
        $survey = $this->survey;
        $feature_config = $this->feature_config;
        $anon_session = $this->repo_service->execution()->runSession();
        if ($feature_config->usesAppraisees() &&
            $anon_session->issetCode($survey->getId())) {
            if (!$anon_session->isExternalRaterValidated($survey->getRefId())) {
                $code = $anon_session->getCode($survey->getId());
                $code_manager = $this->domain_service->code($survey, 0);
                $feature_config = $this->domain_service->modeFeatureConfig($survey->getMode());
                $access_manager = $this->domain_service->access($survey->getRefId(), 0);

                if ($code_manager->exists($code)) {
                    $anonymous_id = $survey->getAnonymousIdByCode($code);
                    if ($anonymous_id) {
                        if (count($survey->getAppraiseesToRate(null, $anonymous_id))) {
                            $anon_session->setExternalRaterValidation($survey->getRefId(), true);
                            return true;
                        }
                    }
                }
                $anon_session->setExternalRaterValidation($survey->getRefId(), false);
                return false;
            }
            return true;
        }
        return false;
    }

mustEnterCode()

ILIAS\Survey\Participants\StatusManager::mustEnterCode

(

string

$code = ""

)

Check if user must enter code to start (and currently is able to start)

Definition at line 131 of file class.StatusManager.php.

References ILIAS\Repository\access(), and ILIAS\Survey\Participants\StatusManager\isAppraisee().

                                                    : bool
    {
        if ($this->access->canStartSurvey()) {
            // code is mandatory and not given yet
            if (!$this->isAppraisee() &&
                $code === "" &&
                !$this->survey->isAccessibleWithoutCode()) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$access

ILIAS Survey Access AccessManager ILIAS\Survey\Participants\StatusManager::$access

protected

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

Referenced by ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee().

$domain_service

InternalDomainService ILIAS\Survey\Participants\StatusManager::$domain_service

protected

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

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

$feature_config

ILIAS Survey Mode FeatureConfig ILIAS\Survey\Participants\StatusManager::$feature_config

protected

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

Referenced by ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee(), ILIAS\Survey\Participants\StatusManager\cantStartAgain(), ILIAS\Survey\Participants\StatusManager\isAppraisee(), and ILIAS\Survey\Participants\StatusManager\isExternalRater().

$repo_service

InternalRepoService ILIAS\Survey\Participants\StatusManager::$repo_service

protected

Definition at line 39 of file class.StatusManager.php.

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

$run_manager

ILIAS Survey Execution RunManager ILIAS\Survey\Participants\StatusManager::$run_manager

protected

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

$survey

ilObjSurvey ILIAS\Survey\Participants\StatusManager::$survey

protected

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

Referenced by ILIAS\Survey\Participants\StatusManager\__construct(), ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee(), ILIAS\Survey\Participants\StatusManager\isAppraisee(), and ILIAS\Survey\Participants\StatusManager\isExternalRater().

$user_id

int ILIAS\Survey\Participants\StatusManager::$user_id

protected

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

Referenced by ILIAS\Survey\Participants\StatusManager\__construct(), and ILIAS\Survey\Participants\StatusManager\canAddItselfAsAppraisee().

---

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

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