ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ILIAS\LearningModule\ReadingTime\ReadingTimeManager Class Reference
+ Collaboration diagram for ILIAS\LearningModule\ReadingTime\ReadingTimeManager:

Public Member Functions

 __construct ()
 
 isGloballyActivated ()
 
 isActivated (int $lm_id)
 
 activate (int $lm_id, bool $activate)
 Set activation. More...
 
 updateReadingTime (int $lm_id)
 Gets the calculated reading time from all pages of the LM and stores it (redundantly for quick access) in the learning module. More...
 
 loadData (array $lm_ids)
 
 getReadingTime (int $lm_id)
 

Protected Attributes

 $page_manager
 
 $repo
 
 $lm_set
 

Detailed Description

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

Definition at line 24 of file class.ReadingTimeManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\COPage\ReadingTime\ReadingTimeManager::__construct ( )

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

40  {
41  $this->lm_set = new \ilSetting("lm");
42  $this->repo = new ReadingTimeDBRepo();
43  $this->page_manager = new \ILIAS\COPage\ReadingTime\ReadingTimeManager();
44  }

Member Function Documentation

◆ activate()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::activate ( int  $lm_id,
bool  $activate 
)

Set activation.

If switched from off to on, ensure all missing page reading times are set.

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

References ILIAS\LearningModule\ReadingTime\ReadingTimeManager\updateReadingTime().

60  : void
61  {
62  $is_active = $this->repo->isActivated($lm_id);
63  $this->repo->activate($lm_id, $activate);
64  if (!$is_active && $activate) {
65  $this->page_manager->setMissingReadingTimes("lm", $lm_id);
66  $this->updateReadingTime($lm_id);
67  }
68  }
updateReadingTime(int $lm_id)
Gets the calculated reading time from all pages of the LM and stores it (redundantly for quick access...
+ Here is the call graph for this function:

◆ getReadingTime()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::getReadingTime ( int  $lm_id)
Returns
int|null Null, if reading time is deactivated

Definition at line 89 of file class.ReadingTimeManager.php.

89  : ?int
90  {
91  return $this->repo->getReadingTime($lm_id);
92  }

◆ isActivated()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::isActivated ( int  $lm_id)

Definition at line 51 of file class.ReadingTimeManager.php.

51  : bool
52  {
53  return $this->repo->isActivated($lm_id);
54  }

◆ isGloballyActivated()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::isGloballyActivated ( )

Definition at line 46 of file class.ReadingTimeManager.php.

46  : bool
47  {
48  return (bool) $this->lm_set->get("est_reading_time");
49  }

◆ loadData()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::loadData ( array  $lm_ids)

Definition at line 81 of file class.ReadingTimeManager.php.

81  : void
82  {
83  $this->repo->loadData($lm_ids);
84  }

◆ updateReadingTime()

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::updateReadingTime ( int  $lm_id)

Gets the calculated reading time from all pages of the LM and stores it (redundantly for quick access) in the learning module.

Definition at line 75 of file class.ReadingTimeManager.php.

Referenced by ILIAS\LearningModule\ReadingTime\ReadingTimeManager\activate().

75  : void
76  {
77  $reading_time = $this->page_manager->getParentReadingTime("lm", $lm_id);
78  $this->repo->saveReadingTime($lm_id, $reading_time);
79  }
+ Here is the caller graph for this function:

Field Documentation

◆ $lm_set

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::$lm_set
protected

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

◆ $page_manager

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::$page_manager
protected

Definition at line 29 of file class.ReadingTimeManager.php.

◆ $repo

ILIAS\LearningModule\ReadingTime\ReadingTimeManager::$repo
protected

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


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