ILIAS\Survey\Code\CodeManager Class Reference

Code manager. More...

Collaboration diagram for ILIAS\Survey\Code\CodeManager:

Public Member Functions
	__construct (CodeDBRepo $code_repo, InternalDataService $data, \ilObjSurvey $survey, InternalDomainService $domain_service, int $user_id)
	deleteAll (bool $force=false)
	Delete all codes of survey. More...
	delete (string $code)
	Delete single code. More...
	exists (string $code)
	Does code exist in survey? More...
	add (Code $code)
	Saves a survey access code for a registered user to the database. More...
	addCodes (int $nr)
	Add multiple new codes. More...
	updateExternalData (int $code_id, string $email, string $last_name, string $first_name, int $sent)
	Update external data of a code. More...
	getAll ()
	Get all access keys of a survey. More...
	getAllData ()
	Get all codes of a survey. More...
	bindUser (string $code, int $user_id)
	Bind registered user to a code. More...
	getByUserId (int $user_id)
	Get access key for a registered user. More...
	getByCodeId (int $code_id)
	getByUserKey (string $user_key)
	Get code object for an access key. More...

Protected Member Functions
	checkPermission ()

Protected Attributes
int	$survey_ref_id = 0
CodeDBRepo	$code_repo
InternalDataService	$data
int	$survey_id
AccessManager	$access
ilLanguage	$lng

Detailed Description

Code manager.

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\Survey\Code\CodeManager::__construct	(	CodeDBRepo	$code_repo,
		InternalDataService	$data,
		\ilObjSurvey	$survey,
		InternalDomainService	$domain_service,
		int	$user_id
	)

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

References ILIAS\Survey\Code\CodeManager\$code_repo, ILIAS\Survey\Code\CodeManager\$data, $user_id, ILIAS\Repository\access(), ILIAS\Survey\InternalDomainService\access(), ilObject\getRefId(), ilObjSurvey\getSurveyId(), and ILIAS\Repository\lng().

      {
        $this->data = $data;
        $this->code_repo = $code_repo;
        $this->survey_id = $survey->getSurveyId();
        $this->survey_ref_id = $survey->getRefId();
        $this->access = $domain_service->access(
            $survey->getRefId(),
            $user_id
        );
        $this->lng = $domain_service->lng();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ILIAS\Survey\Code\CodeManager::add

(

Code

$code

)

Saves a survey access code for a registered user to the database.

Exceptions

Definition at line 106 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\$code_repo, ILIAS\Survey\Code\CodeDBRepo\add(), ILIAS\Survey\Code\Code\getCode(), ILIAS\Survey\Code\Code\getEmail(), ILIAS\Survey\Code\Code\getFirstName(), ILIAS\Survey\Code\Code\getLastName(), ILIAS\Survey\Code\Code\getSent(), ILIAS\Survey\Code\Code\getTimestamp(), and ILIAS\Survey\Code\Code\getUserId().

     : int {
        //$this->checkPermission();
        $repo = $this->code_repo;
        return $repo->add(
            $this->survey_id,
            $code->getCode(),
            $code->getUserId(),
            $code->getEmail(),
            $code->getLastName(),
            $code->getFirstName(),
            $code->getSent(),
            $code->getTimestamp()
        );
    }

Here is the call graph for this function:

addCodes()

ILIAS\Survey\Code\CodeManager::addCodes

(

int

$nr

)

Add multiple new codes.

Parameters

int

$nr

number of codes that should be generated/added

Returns

int[]

Exceptions

Definition at line 130 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\checkPermission().

                                     : array
    {
        $this->checkPermission();
        return $this->code_repo->addCodes($this->survey_id, $nr);
    }

Here is the call graph for this function:

bindUser()

ILIAS\Survey\Code\CodeManager::bindUser	(	string	$code,
		int	$user_id
	)

Bind registered user to a code.

Exceptions

Definition at line 183 of file class.CodeManager.php.

References ANONYMOUS_USER_ID.

     : void {
        if ($user_id === ANONYMOUS_USER_ID) {
            return;
        }
        $this->code_repo->bindUser($this->survey_id, $code, $user_id);
    }

checkPermission()

ILIAS\Survey\Code\CodeManager::checkPermission ( )

protected

Exceptions

Definition at line 61 of file class.CodeManager.php.

References ILIAS\Repository\access(), and ILIAS\Repository\lng().

Referenced by ILIAS\Survey\Code\CodeManager\addCodes(), ILIAS\Survey\Code\CodeManager\delete(), ILIAS\Survey\Code\CodeManager\deleteAll(), ILIAS\Survey\Code\CodeManager\getAll(), ILIAS\Survey\Code\CodeManager\getAllData(), and ILIAS\Survey\Code\CodeManager\updateExternalData().

                                        : void
    {
        if (!$this->access->canManageCodes()) {
            throw new \ilPermissionException($this->lng->txt("permission_denied") .
                " (" . $this->survey_ref_id . ")");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ILIAS\Survey\Code\CodeManager::delete

(

string

$code

)

Delete single code.

Exceptions

Definition at line 86 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\$code_repo, ILIAS\Survey\Code\CodeManager\checkPermission(), and ILIAS\Survey\Code\CodeDBRepo\delete().

                                        : void
    {
        $this->checkPermission();
        $repo = $this->code_repo;
        $repo->delete($this->survey_id, $code);
    }

Here is the call graph for this function:

deleteAll()

ILIAS\Survey\Code\CodeManager::deleteAll

(

bool

$force = false

)

Delete all codes of survey.

Exceptions

Definition at line 73 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\$code_repo, ILIAS\Survey\Code\CodeManager\checkPermission(), and ILIAS\Survey\Code\CodeDBRepo\deleteAll().

                                                  : void
    {
        if (!$force) {
            $this->checkPermission();
        }
        $repo = $this->code_repo;
        $repo->deleteAll($this->survey_id);
    }

Here is the call graph for this function:

exists()

ILIAS\Survey\Code\CodeManager::exists

(

string

$code

)

Does code exist in survey?

Definition at line 96 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\$code_repo, and ILIAS\Survey\Code\CodeDBRepo\exists().

                                        : bool
    {
        $repo = $this->code_repo;
        return $repo->exists($this->survey_id, $code);
    }

Here is the call graph for this function:

getAll()

ILIAS\Survey\Code\CodeManager::getAll

(

)

Get all access keys of a survey.

Returns

string[]

Exceptions

Definition at line 162 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\checkPermission().

                            : array
    {
        $this->checkPermission();
        return $this->code_repo->getAll($this->survey_id);
    }

Here is the call graph for this function:

getAllData()

ILIAS\Survey\Code\CodeManager::getAllData

(

)

Get all codes of a survey.

Returns

Code[]

Exceptions

Definition at line 173 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\checkPermission().

                                : array
    {
        $this->checkPermission();
        return $this->code_repo->getAllData($this->survey_id);
    }

Here is the call graph for this function:

getByCodeId()

ILIAS\Survey\Code\CodeManager::getByCodeId

(

int

$code_id

)

Definition at line 202 of file class.CodeManager.php.

     : string {
        return $this->code_repo->getByCodeId($this->survey_id, $code_id);
    }

getByUserId()

ILIAS\Survey\Code\CodeManager::getByUserId

(

int

$user_id

)

Get access key for a registered user.

Definition at line 196 of file class.CodeManager.php.

     : string {
        return $this->code_repo->getByUserId($this->survey_id, $user_id);
    }

getByUserKey()

ILIAS\Survey\Code\CodeManager::getByUserKey

(

string

$user_key

)

Get code object for an access key.

Definition at line 211 of file class.CodeManager.php.

                                                  : ?Code
    {
        return $this->code_repo->getByUserKey($this->survey_id, $user_key);
    }

updateExternalData()

ILIAS\Survey\Code\CodeManager::updateExternalData	(	int	$code_id,
		string	$email,
		string	$last_name,
		string	$first_name,
		int	$sent
	)

Update external data of a code.

Exceptions

Definition at line 140 of file class.CodeManager.php.

References ILIAS\Survey\Code\CodeManager\checkPermission().

     : bool {
        $this->checkPermission();
        return $this->code_repo->updateExternalData(
            $code_id,
            $email,
            $last_name,
            $first_name,
            $sent
        );
    }

Here is the call graph for this function:

Field Documentation

$access

AccessManager ILIAS\Survey\Code\CodeManager::$access

protected

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

$code_repo

CodeDBRepo ILIAS\Survey\Code\CodeManager::$code_repo

protected

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

Referenced by ILIAS\Survey\Code\CodeManager\__construct(), ILIAS\Survey\Code\CodeManager\add(), ILIAS\Survey\Code\CodeManager\delete(), ILIAS\Survey\Code\CodeManager\deleteAll(), and ILIAS\Survey\Code\CodeManager\exists().

$data

InternalDataService ILIAS\Survey\Code\CodeManager::$data

protected

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

Referenced by ILIAS\Survey\Code\CodeManager\__construct().

$lng

ilLanguage ILIAS\Survey\Code\CodeManager::$lng

protected

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

$survey_id

int ILIAS\Survey\Code\CodeManager::$survey_id

protected

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

$survey_ref_id

int ILIAS\Survey\Code\CodeManager::$survey_ref_id = 0

protected

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

---

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

• components/ILIAS/Survey/Code/class.CodeManager.php