Cron for lp object statistics. More...

Inheritance diagram for ilLPCronObjectStatistics:

Collaboration diagram for ilLPCronObjectStatistics:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	run ()

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?CronJobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Protected Member Functions
	gatherCourseLPData ()
	gather course data More...

	gatherTypesData ()

	gatherUserData ()

Protected Attributes
int	$date = 0

ilLanguage	$lng

ilDBInterface	$db

ilTree	$tree

ilLogger	$logger

ilCronManager	$cron_manager

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Cron for lp object statistics.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 28 of file class.ilLPCronObjectStatistics.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPCronObjectStatistics::__construct ( )

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

References $DIC, ILIAS\Repository\lng(), and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->trac();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("trac");
         $this->db = $DIC->database();
         $this->tree = $DIC->repositoryTree();
         $this->cron_manager = $DIC->cron()->manager();
     }

Here is the call graph for this function:

Member Function Documentation

◆ gatherCourseLPData()

ilLPCronObjectStatistics::gatherCourseLPData ( )

protected

gather course data

Definition at line 112 of file class.ilLPCronObjectStatistics.php.

References ilObject\_getAllReferences(), ilObject\_getObjectsByType(), ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), getId(), ilObjectLP\getInstance(), and ILIAS\Repository\logger().

Referenced by run().

                                            : int
     {
         $count = 0;
 
         // process all courses
         $all_courses = array_keys(ilObject::_getObjectsByType("crs"));
         if ($all_courses) {
             // gather objects in trash
             $trashed_objects = $this->tree->getSavedNodeObjIds($all_courses);
 
             foreach ($all_courses as $crs_id) {
                 // trashed objects will not change
                 if (!in_array($crs_id, $trashed_objects)) {
                     $refs = ilObject::_getAllReferences($crs_id);
                     if (!count($refs)) {
                         $this->logger->warning(
                             'Found course without reference: obj_id = ' . $crs_id
                         );
                         continue;
                     }
 
                     // only if LP is active
                     $olp = ilObjectLP::getInstance($crs_id);
                     if (!$olp->isActive()) {
                         continue;
                     }
 
                     // only save once per day
                     $this->db->manipulate(
                         "DELETE FROM obj_lp_stat WHERE" .
                         " obj_id = " . $this->db->quote($crs_id, "integer") .
                         " AND fulldate = " . $this->db->quote(
                             date("Ymd", $this->date),
                             "integer"
                         )
                     );
 
                     $members = new ilCourseParticipants($crs_id);
                     $members = $members->getMembers();
 
                     $in_progress = count(
                         ilLPStatusWrapper::_lookupInProgressForObject(
                             $crs_id,
                             $members
                         )
                     );
                     $completed = count(
                         ilLPStatusWrapper::_lookupCompletedForObject(
                             $crs_id,
                             $members
                         )
                     );
                     $failed = count(
                         ilLPStatusWrapper::_lookupFailedForObject(
                             $crs_id,
                             $members
                         )
                     );
 
                     // calculate with other values - there is not direct method
                     $not_attempted = count(
                         $members
                     ) - $in_progress - $completed - $failed;
 
                     $set = array(
                         "type" => array("text", "crs"),
                         "obj_id" => array("integer", $crs_id),
                         "yyyy" => array("integer", date("Y", $this->date)),
                         "mm" => array("integer", date("m", $this->date)),
                         "dd" => array("integer", date("d", $this->date)),
                         "fulldate" => array("integer",
                                             date("Ymd", $this->date)
                         ),
                         "mem_cnt" => array("integer", count($members)),
                         "in_progress" => array("integer", $in_progress),
                         "completed" => array("integer", $completed),
                         "failed" => array("integer", $failed),
                         "not_attempted" => array("integer", $not_attempted)
                     );
 
                     $this->db->insert("obj_lp_stat", $set);
                     $count++;
                     $this->cron_manager->ping($this->getId());
                 }
             }
         }
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherTypesData()

ilLPCronObjectStatistics::gatherTypesData ( )

protected

Definition at line 201 of file class.ilLPCronObjectStatistics.php.

References $data, getId(), and ilTrQuery\getObjectTypeStatistics().

Referenced by run().

                                         : int
     {
         $count = 0;
         $data = ilTrQuery::getObjectTypeStatistics();
         foreach ($data as $type => $item) {
             // only save once per day
             $this->db->manipulate(
                 "DELETE FROM obj_type_stat WHERE" .
                 " type = " . $this->db->quote($type, "text") .
                 " AND fulldate = " . $this->db->quote(
                     date("Ymd", $this->date),
                     "integer"
                 )
             );
 
             $set = array(
                 "type" => array("text", $type),
                 "yyyy" => array("integer", date("Y", $this->date)),
                 "mm" => array("integer", date("m", $this->date)),
                 "dd" => array("integer", date("d", $this->date)),
                 "fulldate" => array("integer", date("Ymd", $this->date)),
                 "cnt_references" => array("integer", (int) $item["references"]),
                 "cnt_objects" => array("integer", (int) $item["objects"]),
                 "cnt_deleted" => array("integer", isset($item["deleted"]) ? (int) $item["deleted"] : 0)
             );
 
             $this->db->insert("obj_type_stat", $set);
 
             $count++;
             $this->cron_manager->ping($this->getId());
         }
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherUserData()

ilLPCronObjectStatistics::gatherUserData ( )

protected

Definition at line 235 of file class.ilLPCronObjectStatistics.php.

References getId().

Referenced by run().

                                        : int
     {
         $count = 0;
         $to = mktime(
             23,
             59,
             59,
             date("m", $this->date),
             date("d", $this->date),
             date("Y", $this->date)
         );
 
         $sql = "SELECT COUNT(DISTINCT(usr_id)) counter,obj_id FROM read_event" .
             " WHERE last_access >= " . $this->db->quote(
                 $this->date,
                 "integer"
             ) .
             " AND last_access <= " . $this->db->quote($to, "integer") .
             " GROUP BY obj_id";
         $set = $this->db->query($sql);
         while ($row = $this->db->fetchAssoc($set)) {
             // only save once per day
             $this->db->manipulate(
                 "DELETE FROM obj_user_stat" .
                 " WHERE fulldate = " . $this->db->quote(
                     date("Ymd", $this->date),
                     "integer"
                 ) .
                 " AND obj_id = " . $this->db->quote($row["obj_id"], "integer")
             );
 
             $iset = array(
                 "obj_id" => array("integer", $row["obj_id"]),
                 "yyyy" => array("integer", date("Y", $this->date)),
                 "mm" => array("integer", date("m", $this->date)),
                 "dd" => array("integer", date("d", $this->date)),
                 "fulldate" => array("integer", date("Ymd", $this->date)),
                 "counter" => array("integer", $row["counter"])
             );
 
             $this->db->insert("obj_user_stat", $iset);
 
             $count++;
             $this->cron_manager->ping($this->getId());
         }
         return $count;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilLPCronObjectStatistics::getDefaultScheduleType ( )

Definition at line 65 of file class.ilLPCronObjectStatistics.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilLPCronObjectStatistics::getDefaultScheduleValue ( )

Definition at line 70 of file class.ilLPCronObjectStatistics.php.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilLPCronObjectStatistics::getDescription ( )

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

References ILIAS\Repository\lng().

                                     : string
     {
         return $this->lng->txt("trac_object_statistics_info");
     }

Here is the call graph for this function:

◆ getId()

ilLPCronObjectStatistics::getId ( )

Definition at line 50 of file class.ilLPCronObjectStatistics.php.

Referenced by gatherCourseLPData(), gatherTypesData(), and gatherUserData().

                            : string
     {
         return "lp_object_statistics";
     }

Here is the caller graph for this function:

◆ getTitle()

ilLPCronObjectStatistics::getTitle ( )

Definition at line 55 of file class.ilLPCronObjectStatistics.php.

References ILIAS\Repository\lng().

                               : string
     {
         return $this->lng->txt("trac_object_statistics");
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilLPCronObjectStatistics::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilLPCronObjectStatistics::hasFlexibleSchedule ( )

Definition at line 80 of file class.ilLPCronObjectStatistics.php.

                                          : bool
     {
         return false;
     }

◆ run()

ilLPCronObjectStatistics::run ( )

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

References $message, gatherCourseLPData(), gatherTypesData(), gatherUserData(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                          : ilCronJobResult
     {
         // all date related operations are based on this timestamp
         // should be midnight of yesterday (see gatherUserData()) to always have full day
         $this->date = strtotime("yesterday");
 
         $status = ilCronJobResult::STATUS_NO_ACTION;
         $message = array();
 
         $count = 0;
         $count += $this->gatherCourseLPData();
         $count += $this->gatherTypesData();
         $count += $this->gatherUserData();
 
         if ($count) {
             $status = ilCronJobResult::STATUS_OK;
         }
 
         $result = new ilCronJobResult();
         $result->setStatus($status);
 
         return $result;
     }

Here is the call graph for this function:

Field Documentation

◆ $cron_manager

ilCronManager ilLPCronObjectStatistics::$cron_manager

protected

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

◆ $date

int ilLPCronObjectStatistics::$date = 0

protected

Definition at line 30 of file class.ilLPCronObjectStatistics.php.

◆ $db

ilDBInterface ilLPCronObjectStatistics::$db

protected

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

◆ $lng

ilLanguage ilLPCronObjectStatistics::$lng

protected

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

◆ $logger

ilLogger ilLPCronObjectStatistics::$logger

protected

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

◆ $tree

ilTree ilLPCronObjectStatistics::$tree

protected

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

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

Services/Tracking/classes/class.ilLPCronObjectStatistics.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ gatherCourseLPData()

◆ gatherTypesData()

◆ gatherUserData()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ run()

Field Documentation

◆ $cron_manager

◆ $date

◆ $db

◆ $lng

◆ $logger

◆ $tree