ILIAS\Glossary\Flashcard\FlashcardManager Class Reference

Collaboration diagram for ILIAS\Glossary\Flashcard\FlashcardManager:

Public Member Functions
	__construct (InternalDomainService $domain_service, Glossary\InternalRepoServiceInterface $repo, int $glo_ref_id, int $user_id)
	setSessionInitialTerms (int $box_nr, array $initial_terms)
	getSessionInitialTerms (int $box_nr)
	setSessionTerms (int $box_nr, array $terms)
	getSessionTerms (int $box_nr)
	getAllTermsWithoutEntry ()
	getAllUserTermIds ()
	getUserTermIdsForBox (int $box_nr)
	getNonTodayUserTermIdsForBox (int $box_nr)
	getTodayUserTermIdsForBox (int $box_nr)
	getItemsForBoxCount (int $box_nr)
	getLastAccessForBox (int $box_nr)
	getLastAccessForBoxAsDaysText (int $box_nr)
	getBoxNr (int $term_id)
	getBoxProgress (array $current_terms, array $all_terms)
	createOrUpdateBoxAccessEntry (int $box_nr)
	createOrUpdateUserTermEntry (int $term_id, bool $correct)
	resetEntries ()
	deleteAllUserEntries ()
	deleteAllGlossaryEntries ()
	deleteAllTermEntries (int $term_id)

Protected Member Functions
	filterTermsNotInGlossary (array $term_ids)
	Filter out the terms, for which already exist entries, but are not part of the glossary currently/anymore. More...

Protected Attributes
InternalDomainService	$domain
FlashcardShuffleManager	$shuffle_manager
Glossary InternalRepoServiceInterface	$repo
FlashcardTermDBRepository	$term_db_repo
FlashcardBoxDBRepository	$box_db_repo
FlashcardSessionRepository	$session_repo
int	$glo_id
int	$user_id
ilObjGlossary	$glossary
ClockInterface	$clock
array	$all_glossary_term_ids = []

Detailed Description

Author

Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 32 of file class.FlashcardManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Glossary\Flashcard\FlashcardManager::__construct	(	InternalDomainService	$domain_service,
		Glossary\InternalRepoServiceInterface	$repo,
		int	$glo_ref_id,
		int	$user_id
	)

Definition at line 49 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\$repo, ILIAS\Glossary\Flashcard\FlashcardManager\$user_id, ilObject\_lookupObjectId(), ILIAS\Glossary\InternalDomainService\flashcardShuffle(), ILIAS\Glossary\InternalRepoServiceInterface\flashcardTerm(), and ILIAS\Repository\int().

      {
        $data_factory = new DataFactory();

        $this->domain = $domain_service;
        $this->shuffle_manager = $this->domain->flashcardShuffle();
        $this->repo = $repo;
        $this->term_db_repo = $this->repo->flashcardTerm();
        $this->box_db_repo = $this->repo->flashcardBox();
        $this->session_repo = $this->repo->flashcardSession();
        $this->glo_id = \ilObject::_lookupObjectId($glo_ref_id);
        $this->user_id = $user_id;
        $this->glossary = new \ilObjGlossary($glo_ref_id);
        $this->clock = $data_factory->clock()->system();

        $all_glossary_terms = $this->glossary->getTermList(
            "",
            "",
            "",
            0,
            false,
            false,
            null,
            false,
            true
        );
        foreach ($all_glossary_terms as $term) {
            $term_id = (int) $term["id"];
            $this->all_glossary_term_ids[] = $term_id;
        }
    }

Here is the call graph for this function:

Member Function Documentation

createOrUpdateBoxAccessEntry()

ILIAS\Glossary\Flashcard\FlashcardManager::createOrUpdateBoxAccessEntry

(

int

$box_nr

)

Definition at line 288 of file class.FlashcardManager.php.

     : void {
        $now = $this->clock->now()->format("Y-m-d H:i:s");
        $this->box_db_repo->createOrUpdateEntry($box_nr, $this->user_id, $this->glo_id, $now);
    }

createOrUpdateUserTermEntry()

ILIAS\Glossary\Flashcard\FlashcardManager::createOrUpdateUserTermEntry	(	int	$term_id,
		bool	$correct
	)

Definition at line 295 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\getBoxNr().

     : void {
        $box_nr = $this->getBoxNr($term_id);
        $now = $this->clock->now()->format("Y-m-d H:i:s");

        if ($box_nr !== 0) {
            $box_nr = $correct ? ($box_nr + 1) : 1;
            $this->term_db_repo->updateEntry($term_id, $this->user_id, $this->glo_id, $box_nr, $now);
        } else {
            $box_nr = $correct ? 2 : 1;
            $this->term_db_repo->createEntry($term_id, $this->user_id, $this->glo_id, $box_nr, $now);
        }
    }

Here is the call graph for this function:

deleteAllGlossaryEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::deleteAllGlossaryEntries

(

)

Definition at line 323 of file class.FlashcardManager.php.

                                              : void
    {
        if ($this->glo_id === 0) {
            throw new \ilGlossaryException("No glossary id given in FlashcardManager.");
        }
        $this->term_db_repo->deleteAllGlossaryEntries($this->glo_id);
        $this->box_db_repo->deleteAllGlossaryEntries($this->glo_id);
    }

deleteAllTermEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::deleteAllTermEntries

(

int

$term_id

)

Definition at line 332 of file class.FlashcardManager.php.

     : void {
        $this->term_db_repo->deleteAllTermEntries($term_id);
    }

deleteAllUserEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::deleteAllUserEntries

(

)

Definition at line 317 of file class.FlashcardManager.php.

                                          : void
    {
        $this->term_db_repo->deleteAllUserEntries($this->user_id);
        $this->box_db_repo->deleteAllUserEntries($this->user_id);
    }

filterTermsNotInGlossary()

ILIAS\Glossary\Flashcard\FlashcardManager::filterTermsNotInGlossary ( array  $term_ids )

protected

Filter out the terms, for which already exist entries, but are not part of the glossary currently/anymore.

Only relevant for virtual glossaries.

Parameters

int[]

$term_ids

Returns

int[]

Definition at line 156 of file class.FlashcardManager.php.

References $id.

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getNonTodayUserTermIdsForBox(), ILIAS\Glossary\Flashcard\FlashcardManager\getTodayUserTermIdsForBox(), and ILIAS\Glossary\Flashcard\FlashcardManager\getUserTermIdsForBox().

     : array {
        $term_ids_filtered = [];
        foreach ($term_ids as $id) {
            if (in_array($id, $this->all_glossary_term_ids)) {
                $term_ids_filtered[] = $id;
            }
        }

        return $term_ids_filtered;
    }

Here is the caller graph for this function:

getAllTermsWithoutEntry()

ILIAS\Glossary\Flashcard\FlashcardManager::getAllTermsWithoutEntry

(

)

Returns

int[]

Definition at line 120 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\getAllUserTermIds().

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getItemsForBoxCount().

                                             : array
    {
        $terms_with_entry = $this->getAllUserTermIds();

        $terms_without_entry = [];
        foreach ($this->all_glossary_term_ids as $term_id) {
            if (!in_array($term_id, $terms_with_entry)) {
                $terms_without_entry[] = $term_id;
            }
        }
        $terms_without_entry = $this->shuffle_manager->shuffleEntries($terms_without_entry);

        return $terms_without_entry;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllUserTermIds()

ILIAS\Glossary\Flashcard\FlashcardManager::getAllUserTermIds

(

)

Returns

int[]

Definition at line 138 of file class.FlashcardManager.php.

References ILIAS\Repository\int().

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getAllTermsWithoutEntry().

                                       : array
    {
        $entries = $this->term_db_repo->getAllUserEntries($this->user_id, $this->glo_id);
        $term_ids = [];
        foreach ($entries as $entry) {
            $term_ids[] = (int) $entry["term_id"];
        }

        return $term_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBoxNr()

ILIAS\Glossary\Flashcard\FlashcardManager::getBoxNr

(

int

$term_id

)

Definition at line 272 of file class.FlashcardManager.php.

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\createOrUpdateUserTermEntry().

     : int {
        return $this->term_db_repo->getBoxNr($term_id, $this->user_id, $this->glo_id);
    }

Here is the caller graph for this function:

getBoxProgress()

ILIAS\Glossary\Flashcard\FlashcardManager::getBoxProgress	(	array	$current_terms,
		array	$all_terms
	)

Definition at line 278 of file class.FlashcardManager.php.

References ILIAS\Repository\int().

     : int {
        $shown_terms_cnt = count($all_terms) - count($current_terms);
        $progress = (int) round((($shown_terms_cnt + 1) / count($all_terms)) * 100);

        return $progress;
    }

Here is the call graph for this function:

getItemsForBoxCount()

ILIAS\Glossary\Flashcard\FlashcardManager::getItemsForBoxCount

(

int

$box_nr

)

Definition at line 228 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardBox\FIRST_BOX, ILIAS\Glossary\Flashcard\FlashcardManager\getAllTermsWithoutEntry(), and ILIAS\Glossary\Flashcard\FlashcardManager\getUserTermIdsForBox().

     : int {
        if ($box_nr === FlashcardBox::FIRST_BOX) {
            $items_without_box = count($this->getAllTermsWithoutEntry());
            $items_in_box = count($this->getUserTermIdsForBox($box_nr));
            $item_cnt = $items_without_box + $items_in_box;
        } else {
            $item_cnt = count($this->getUserTermIdsForBox($box_nr));
        }

        return $item_cnt;
    }

Here is the call graph for this function:

getLastAccessForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getLastAccessForBox

(

int

$box_nr

)

Definition at line 242 of file class.FlashcardManager.php.

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getLastAccessForBoxAsDaysText().

     : ?string {
        $entry = $this->box_db_repo->getEntry($box_nr, $this->user_id, $this->glo_id);
        $date = $entry["last_access"] ?? null;

        return $date;
    }

Here is the caller graph for this function:

getLastAccessForBoxAsDaysText()

ILIAS\Glossary\Flashcard\FlashcardManager::getLastAccessForBoxAsDaysText

(

int

$box_nr

)

Definition at line 251 of file class.FlashcardManager.php.

References $lng, ILIAS\Glossary\Flashcard\FlashcardManager\getLastAccessForBox(), IL_CAL_DATE, and IL_CAL_DATETIME.

     : string {
        $lng = $this->domain->lng();
        $date_str = $this->getLastAccessForBox($box_nr);
        if (!$date_str) {
            return $lng->txt("never");
        }
        $date_tmp = new \ilDateTime($date_str, IL_CAL_DATETIME);
        $date = new DateTime($date_tmp->get(IL_CAL_DATE));
        $now = new DateTime($this->clock->now()->format("Y-m-d"));
        $diff = $date->diff($now)->days;
        if ($diff === 0) {
            return $lng->txt("today");
        } elseif ($diff === 1) {
            return $lng->txt("yesterday");
        } else {
            return sprintf($lng->txt("glo_days_ago"), $diff);
        }
    }

Here is the call graph for this function:

getNonTodayUserTermIdsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getNonTodayUserTermIdsForBox

(

int

$box_nr

)

Returns

int[]

Definition at line 189 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\filterTermsNotInGlossary(), and ILIAS\Repository\int().

     : array {
        $entries = $this->term_db_repo->getUserEntriesForBox($box_nr, $this->user_id, $this->glo_id);
        $entries = $this->shuffle_manager->shuffleEntriesWithEqualDay($entries);
        $non_recent_term_ids = [];
        foreach ($entries as $entry) {
            $entry_day = substr($entry["last_access"], 0, 10);
            $today = $this->clock->now()->format("Y-m-d");
            if ($entry_day !== $today) {
                $non_recent_term_ids[] = (int) $entry["term_id"];
            }
        }
        $non_recent_term_ids = $this->filterTermsNotInGlossary($non_recent_term_ids);

        return $non_recent_term_ids;
    }

Here is the call graph for this function:

getSessionInitialTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::getSessionInitialTerms

(

int

$box_nr

)

Returns

int[]

Definition at line 95 of file class.FlashcardManager.php.

     : array {
        return $this->session_repo->getInitialTerms($this->glo_id, $this->user_id, $box_nr);
    }

getSessionTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::getSessionTerms

(

int

$box_nr

)

Returns

int[]

Definition at line 111 of file class.FlashcardManager.php.

     : array {
        return $this->session_repo->getTerms($this->glo_id, $this->user_id, $box_nr);
    }

getTodayUserTermIdsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getTodayUserTermIdsForBox

(

int

$box_nr

)

Returns

int[]

Definition at line 210 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\filterTermsNotInGlossary(), and ILIAS\Repository\int().

     : array {
        $entries = $this->term_db_repo->getUserEntriesForBox($box_nr, $this->user_id, $this->glo_id);
        $recent_term_ids = [];
        foreach ($entries as $entry) {
            $entry_day = substr($entry["last_access"], 0, 10);
            $today = $this->clock->now()->format("Y-m-d");
            if ($entry_day === $today) {
                $recent_term_ids[] = (int) $entry["term_id"];
            }
        }
        $recent_term_ids = $this->shuffle_manager->shuffleEntries($recent_term_ids);
        $recent_term_ids = $this->filterTermsNotInGlossary($recent_term_ids);

        return $recent_term_ids;
    }

Here is the call graph for this function:

getUserTermIdsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getUserTermIdsForBox

(

int

$box_nr

)

Returns

int[]

Definition at line 172 of file class.FlashcardManager.php.

References ILIAS\Glossary\Flashcard\FlashcardManager\filterTermsNotInGlossary(), and ILIAS\Repository\int().

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getItemsForBoxCount().

     : array {
        $entries = $this->term_db_repo->getUserEntriesForBox($box_nr, $this->user_id, $this->glo_id);
        $entries = $this->shuffle_manager->shuffleEntriesWithEqualDay($entries);
        $term_ids = [];
        foreach ($entries as $entry) {
            $term_ids[] = (int) $entry["term_id"];
        }
        $term_ids = $this->filterTermsNotInGlossary($term_ids);

        return $term_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::resetEntries

(

)

Definition at line 311 of file class.FlashcardManager.php.

                                  : void
    {
        $this->term_db_repo->deleteEntries($this->glo_id, $this->user_id);
        $this->box_db_repo->deleteEntries($this->glo_id, $this->user_id);
    }

setSessionInitialTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::setSessionInitialTerms	(	int	$box_nr,
		array	$initial_terms
	)

Definition at line 85 of file class.FlashcardManager.php.

     : void {
        $this->session_repo->setInitialTerms($this->glo_id, $this->user_id, $box_nr, $initial_terms);
    }

setSessionTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::setSessionTerms	(	int	$box_nr,
		array	$terms
	)

Definition at line 101 of file class.FlashcardManager.php.

     : void {
        $this->session_repo->setTerms($this->glo_id, $this->user_id, $box_nr, $terms);
    }

Field Documentation

$all_glossary_term_ids

array ILIAS\Glossary\Flashcard\FlashcardManager::$all_glossary_term_ids = []

protected

Definition at line 47 of file class.FlashcardManager.php.

$box_db_repo

FlashcardBoxDBRepository ILIAS\Glossary\Flashcard\FlashcardManager::$box_db_repo

protected

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

$clock

ClockInterface ILIAS\Glossary\Flashcard\FlashcardManager::$clock

protected

Definition at line 43 of file class.FlashcardManager.php.

$domain

InternalDomainService ILIAS\Glossary\Flashcard\FlashcardManager::$domain

protected

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

$glo_id

int ILIAS\Glossary\Flashcard\FlashcardManager::$glo_id

protected

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

$glossary

ilObjGlossary ILIAS\Glossary\Flashcard\FlashcardManager::$glossary

protected

Definition at line 42 of file class.FlashcardManager.php.

$repo

Glossary InternalRepoServiceInterface ILIAS\Glossary\Flashcard\FlashcardManager::$repo

protected

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

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\__construct().

$session_repo

FlashcardSessionRepository ILIAS\Glossary\Flashcard\FlashcardManager::$session_repo

protected

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

$shuffle_manager

FlashcardShuffleManager ILIAS\Glossary\Flashcard\FlashcardManager::$shuffle_manager

protected

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

$term_db_repo

FlashcardTermDBRepository ILIAS\Glossary\Flashcard\FlashcardManager::$term_db_repo

protected

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

$user_id

int ILIAS\Glossary\Flashcard\FlashcardManager::$user_id

protected

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

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\__construct().

---

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

• Modules/Glossary/Flashcard/class.FlashcardManager.php