ILIAS\Glossary\Flashcard\FlashcardManager Class Reference

Collaboration diagram for ILIAS\Glossary\Flashcard\FlashcardManager:

Public Member Functions
	__construct (Glossary\InternalDomainService $domain_service, Glossary\InternalRepoServiceInterface $repo, Glossary\InternalDataService $data_service, 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 ()
	getAllUserTerms ()
	getUserTermsForBox (int $box_nr)
	getNonTodayUserTermsForBox (int $box_nr)
	getTodayUserTermsForBox (int $box_nr)
	getItemsForBoxCount (int $box_nr)
	getLastAccessForBox (int $box_nr)
	getLastAccessForBoxAsDaysText (int $box_nr)
	getBoxNr (int $term_id)
	createOrUpdateBoxAccessEntry (int $box_nr)
	createOrUpdateUserTermEntry (int $term_id, bool $correct)
	resetEntries ()
	deleteAllUserEntries ()
	deleteAllGlossaryEntries ()
	deleteAllTermEntries (int $term_id)

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

Protected Attributes
Glossary InternalDomainService	$domain
FlashcardShuffleManager	$shuffle_manager
Glossary InternalRepoServiceInterface	$repo
Glossary InternalDataService	$data_service
FlashcardTermDBRepository	$term_db_repo
FlashcardBoxDBRepository	$box_db_repo
FlashcardSessionRepositoryInterface	$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 31 of file class.FlashcardManager.php.

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\Glossary\Flashcard\FlashcardManager\$data_service, ILIAS\Glossary\Flashcard\FlashcardManager\$repo, ILIAS\Glossary\Flashcard\FlashcardManager\$user_id, ilObject\_lookupObjectId(), and ILIAS\Repository\int().

      {
        $data_factory = new DataFactory();

        $this->domain = $domain_service;
        $this->shuffle_manager = $this->domain->flashcardShuffle();
        $this->repo = $repo;
        $this->data_service = $data_service;
        $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) {
            $this->all_glossary_term_ids[] = (int) $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 281 of file class.FlashcardManager.php.

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

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

Here is the call graph for this function:

createOrUpdateUserTermEntry()

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

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

References ILIAS\Glossary\Flashcard\FlashcardManager\getBoxNr(), and ILIAS\Glossary\Flashcard\FlashcardManager\getNow().

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

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

Here is the call graph for this function:

deleteAllGlossaryEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::deleteAllGlossaryEntries

(

)

Definition at line 319 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 328 of file class.FlashcardManager.php.

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

deleteAllUserEntries()

ILIAS\Glossary\Flashcard\FlashcardManager::deleteAllUserEntries

(

)

Definition at line 313 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  $terms )

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

Term[]

$terms

Returns

Term[]

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

References ILIAS\Glossary\Flashcard\FlashcardManager\$all_glossary_term_ids.

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\getNonTodayUserTermsForBox(), ILIAS\Glossary\Flashcard\FlashcardManager\getTodayUserTermsForBox(), and ILIAS\Glossary\Flashcard\FlashcardManager\getUserTermsForBox().

     : array {
        $terms_filtered = [];
        foreach ($terms as $term) {
            if (in_array($term->getTermId(), $this->all_glossary_term_ids)) {
                $terms_filtered[] = $term;
            }
        }

        return $terms_filtered;
    }

Here is the caller graph for this function:

getAllTermsWithoutEntry()

ILIAS\Glossary\Flashcard\FlashcardManager::getAllTermsWithoutEntry

(

)

Returns

Term[]

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

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

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

                                             : array
    {
        $terms_with_entry = array_map(fn($term) => $term->getTermId(), $this->getAllUserTerms());

        $terms_without_entry = [];
        foreach ($this->all_glossary_term_ids as $term_id) {
            if (!in_array($term_id, $terms_with_entry)) {
                $terms_without_entry[] = $this->data_service->flashcardTerm($term_id, $this->user_id, $this->glo_id, 1);
            }
        }
        $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:

getAllUserTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::getAllUserTerms

(

)

Returns

Term[]

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

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

                                     : array
    {
        $entries = $this->term_db_repo->getAllUserEntries($this->user_id, $this->glo_id);

        return $entries;
    }

Here is the caller graph for this function:

getBoxNr()

ILIAS\Glossary\Flashcard\FlashcardManager::getBoxNr

(

int

$term_id

)

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

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

     : ?int {
        $entry = $this->term_db_repo->getEntry($term_id, $this->user_id, $this->glo_id);

        return $entry?->getBoxNr();
    }

Here is the caller 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\getUserTermsForBox().

     : int {
        if ($box_nr === FlashcardBox::FIRST_BOX) {
            $items_without_box = count($this->getAllTermsWithoutEntry());
            $items_in_box = count($this->getUserTermsForBox($box_nr));
            $item_cnt = $items_without_box + $items_in_box;
        } else {
            $item_cnt = count($this->getUserTermsForBox($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);

        return $entry?->getLastAccess();
    }

Here is the caller graph for this function:

getLastAccessForBoxAsDaysText()

ILIAS\Glossary\Flashcard\FlashcardManager::getLastAccessForBoxAsDaysText

(

int

$box_nr

)

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

References $lng, ILIAS\Glossary\Flashcard\FlashcardManager\getLastAccessForBox(), ILIAS\Glossary\Flashcard\FlashcardManager\getNow(), 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->getNow()->format("Y-m-d"));
        $diff = $date->diff($now)->days;
        if ($diff < 0) {
            return "invalid";
        } elseif ($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:

getNonTodayUserTermsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getNonTodayUserTermsForBox

(

int

$box_nr

)

Returns

Term[]

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

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

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

        return $non_recent_terms;
    }

Here is the call graph for this function:

getNow()

ILIAS\Glossary\Flashcard\FlashcardManager::getNow ( )

protected

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

Referenced by ILIAS\Glossary\Flashcard\FlashcardManager\createOrUpdateBoxAccessEntry(), ILIAS\Glossary\Flashcard\FlashcardManager\createOrUpdateUserTermEntry(), ILIAS\Glossary\Flashcard\FlashcardManager\getLastAccessForBoxAsDaysText(), ILIAS\Glossary\Flashcard\FlashcardManager\getNonTodayUserTermsForBox(), and ILIAS\Glossary\Flashcard\FlashcardManager\getTodayUserTermsForBox().

                               : \DateTimeImmutable
    {
        $now = $this->clock->now();

        return $now;
    }

Here is the caller graph for this function:

getSessionInitialTerms()

ILIAS\Glossary\Flashcard\FlashcardManager::getSessionInitialTerms

(

int

$box_nr

)

Returns

Term[]

Definition at line 103 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

Term[]

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

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

getTodayUserTermsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getTodayUserTermsForBox

(

int

$box_nr

)

Returns

Term[]

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

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

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

        return $recent_terms;
    }

Here is the call graph for this function:

getUserTermsForBox()

ILIAS\Glossary\Flashcard\FlashcardManager::getUserTermsForBox

(

int

$box_nr

)

Returns

Term[]

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

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

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);
        $entries = $this->filterTermsNotInGlossary($entries);

        return $entries;
    }

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 307 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 93 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 109 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.

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

$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.

$data_service

Glossary InternalDataService ILIAS\Glossary\Flashcard\FlashcardManager::$data_service

protected

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

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

$domain

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

protected

Definition at line 33 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 35 of file class.FlashcardManager.php.

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

$session_repo

FlashcardSessionRepositoryInterface 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 34 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:

• components/ILIAS/Glossary/Flashcard/class.FlashcardManager.php