This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilLPCronObjectStatistics:

Collaboration diagram for ilLPCronObjectStatistics:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

	hasFlexibleSchedule ()

	run ()

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

	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 27 of file class.ilLPCronObjectStatistics.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPCronObjectStatistics::__construct ( )

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

    {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ gatherCourseLPData()

ilLPCronObjectStatistics::gatherCourseLPData ( )

protected

gather course data

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

                                           : 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;
    }

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

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherTypesData()

ilLPCronObjectStatistics::gatherTypesData ( )

protected

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

                                        : 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;
    }

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

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherUserData()

ilLPCronObjectStatistics::gatherUserData ( )

protected

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

                                       : 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;
    }

References getId().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilLPCronObjectStatistics::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilLPCronObjectStatistics::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilLPCronObjectStatistics::getDescription ( )

Reimplemented from ilCronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilLPCronObjectStatistics::getId ( )

Reimplemented from ilCronJob.

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

                           : string
    {
        return "lp_object_statistics";
    }

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

Here is the caller graph for this function:

◆ getTitle()

ilLPCronObjectStatistics::getTitle ( )

Reimplemented from ilCronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilLPCronObjectStatistics::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilLPCronObjectStatistics::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

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

                                         : bool
    {
        return false;
    }

◆ run()

ilLPCronObjectStatistics::run ( )

Reimplemented from ilCronJob.

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

                         : 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;
    }