ilLPCronObjectStatistics Class Reference

Cron for lp object statistics. More...

Inheritance diagram for ilLPCronObjectStatistics:

Collaboration diagram for ilLPCronObjectStatistics:

Public Member Functions
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	run ()
	Run job. More...
Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule ($a_type, $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...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...
	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...
	getId ()
	Get id. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	run ()
	Run job. More...

Protected Member Functions
	gatherCourseLPData ()
	gather course data @global type $tree @global type $ilDB More...
	gatherTypesData ()
	gatherUserData ()
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$date

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
const	SCHEDULE_TYPE_IN_MINUTES = 2
const	SCHEDULE_TYPE_IN_HOURS = 3
const	SCHEDULE_TYPE_IN_DAYS = 4
const	SCHEDULE_TYPE_WEEKLY = 5
const	SCHEDULE_TYPE_MONTHLY = 6
const	SCHEDULE_TYPE_QUARTERLY = 7
const	SCHEDULE_TYPE_YEARLY = 8

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 13 of file class.ilLPCronObjectStatistics.php.

Member Function Documentation

gatherCourseLPData()

ilLPCronObjectStatistics::gatherCourseLPData ( )

protected

gather course data @global type $tree @global type $ilDB

Returns

int

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

    {
        global $DIC;
 
        $tree = $DIC['tree'];
        $ilDB = $DIC['ilDB'];
        
        $logger = $GLOBALS['DIC']->logger()->trac();
        
        $count = 0;
                
        // process all courses
        $all_courses = array_keys(ilObject::_getObjectsByType("crs"));
        if ($all_courses) {
            // gather objects in trash
            $trashed_objects = $tree->getSavedNodeObjIds($all_courses);
            
            include_once 'Services/Object/classes/class.ilObjectLP.php';
            include_once "Modules/Course/classes/class.ilCourseParticipants.php";
            include_once "Services/Tracking/classes/class.ilLPStatusWrapper.php";
            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)) {
                        $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
                    $ilDB->manipulate("DELETE FROM obj_lp_stat WHERE" .
                        " obj_id = " . $ilDB->quote($crs_id, "integer") .
                        " AND fulldate = " . $ilDB->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)
                        );
                    
                    $ilDB->insert("obj_lp_stat", $set);
                    
                    $count++;
                    
                    // #17928
                    ilCronManager::ping($this->getId());
                }
            }
        }
        
        return $count;
    }

References $DIC, $failed, $GLOBALS, $ilDB, ilObject\_getAllReferences(), ilObject\_getObjectsByType(), ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), getId(), ilObjectLP\getInstance(), and ilCronManager\ping().

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 169 of file class.ilLPCronObjectStatistics.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $count = 0;
        
        include_once "Services/Tracking/classes/class.ilTrQuery.php";
        $data = ilTrQuery::getObjectTypeStatistics();
        foreach ($data as $type => $item) {
            // only save once per day
            $ilDB->manipulate("DELETE FROM obj_type_stat WHERE" .
                " type = " . $ilDB->quote($type, "text") .
                " AND fulldate = " . $ilDB->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", (int) $item["deleted"])
                );
 
            $ilDB->insert("obj_type_stat", $set);
            
            $count++;
            
            // #17928
            ilCronManager::ping($this->getId());
        }
        
        return $count;
    }

References $data, $DIC, $ilDB, $type, getId(), ilTrQuery\getObjectTypeStatistics(), and ilCronManager\ping().

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 207 of file class.ilLPCronObjectStatistics.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $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 >= " . $ilDB->quote($this->date, "integer") .
            " AND last_access <= " . $ilDB->quote($to, "integer") .
            " GROUP BY obj_id";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            // only save once per day
            $ilDB->manipulate("DELETE FROM obj_user_stat" .
                " WHERE fulldate = " . $ilDB->quote(date("Ymd", $this->date), "integer") .
                " AND obj_id = " . $ilDB->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"])
                );
 
            $ilDB->insert("obj_user_stat", $iset);
            
            $count++;
            
            // #17928
            ilCronManager::ping($this->getId());
        }
        
        return $count;
    }

References $DIC, $ilDB, getId(), and ilCronManager\ping().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilLPCronObjectStatistics::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilLPCronObjectStatistics::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilLPCronObjectStatistics::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("trac");
        return $lng->txt("trac_object_statistics_info");
    }

References $DIC, and $lng.

getId()

ilLPCronObjectStatistics::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "lp_object_statistics";
    }

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

Here is the caller graph for this function:

getTitle()

ilLPCronObjectStatistics::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("trac");
        return $lng->txt("trac_object_statistics");
    }

References $DIC, and $lng.

hasAutoActivation()

ilLPCronObjectStatistics::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

hasFlexibleSchedule()

ilLPCronObjectStatistics::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

run()

ilLPCronObjectStatistics::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        // 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;
    }

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

Here is the call graph for this function:

Field Documentation

$date

ilLPCronObjectStatistics::$date

protected

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

---

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

• Services/Tracking/classes/class.ilLPCronObjectStatistics.php