Handle user timings. More...

Collaboration diagram for ilTimingsUser:

Public Member Functions
	getContainerObjId ()
	Get container obj id. More...

	getContainerRefId ()
	Get container ref_id. More...

	getItemIds ()

	init ()
	Init activation items. More...

	handleNewMembership ($a_usr_id, ilDateTime $sub_date)

	handleUnsubscribe ($a_usr_id)
	Handle unsubscribe. More...

Static Public Member Functions
static	getInstanceByContainerId ($a_container_obj_id)
	Get instance by container id. More...

static	lookupTimingsExceededByUser (array $a_user_ids)
	Check if users currently exceeded ANY object. More...

static	lookupTimings (array $a_user_ids, array &$a_meta=null, $a_only_exceeded=true)
	Lookup references, users with exceeded timings. More...

static	getObjectsWithInactiveLP (array $a_ref_ids, array &$a_obj_map=null)
	Check object LP modes. More...

Protected Member Functions
	__construct ($a_container_obj_id)
	Singleton constructor. More...

Private Attributes
	$container_obj_id = 0

	$container_ref_id = 0

	$initialized = false

	$item_ids = array()

Static Private Attributes
static	$instances = array()

Detailed Description

Handle user timings.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilTimingsUser.php.

Constructor & Destructor Documentation

◆ __construct()

ilTimingsUser::__construct ( $a_container_obj_id )

protected

Singleton constructor.

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

    {
        $this->container_obj_id = $a_container_obj_id;
        
        $refs = ilObject::_getAllReferences($a_container_obj_id);
        $this->container_ref_id = end($refs);
    }

References ilObject\_getAllReferences().

Here is the call graph for this function:

Member Function Documentation

◆ getContainerObjId()

ilTimingsUser::getContainerObjId ( )

Get container obj id.

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

    {
        return $this->container_obj_id;
    }

References $container_obj_id.

◆ getContainerRefId()

ilTimingsUser::getContainerRefId ( )

Get container ref_id.

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

    {
        return $this->container_ref_id;
    }

References $container_ref_id.

Referenced by init().

Here is the caller graph for this function:

◆ getInstanceByContainerId()

static ilTimingsUser::getInstanceByContainerId ( $a_container_obj_id )

static

Get instance by container id.

Parameters

int $a_container_obj_id

Returns: ilTimingsUser

Definition at line 41 of file class.ilTimingsUser.php.

    {
        if (array_key_exists($a_container_obj_id, self::$instances)) {
            return self::$instances[$a_container_obj_id];
        }
        return self::$instances[$a_container_obj_id] = new self($a_container_obj_id);
    }

Referenced by ilCourseAppEventListener\destroyTimings(), and ilCourseAppEventListener\initializeTimings().

Here is the caller graph for this function:

◆ getItemIds()

ilTimingsUser::getItemIds ( )

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

    {
        return $this->item_ids;
    }

References $item_ids.

Referenced by handleNewMembership().

Here is the caller graph for this function:

◆ getObjectsWithInactiveLP()

static ilTimingsUser::getObjectsWithInactiveLP	(	array	$a_ref_ids,
		array &	$a_obj_map = `null`
	)

static

Check object LP modes.

Parameters

int[]	$a_ref_ids
array	&$a_obj_map

Returns: array

Definition at line 345 of file class.ilTimingsUser.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = array();
        $query = 'SELECT oref.ref_id, oref.obj_id, od.type' .
            ' FROM object_reference oref' .
            ' JOIN object_data od ON (oref.obj_id = od.obj_id)' .
            ' WHERE ' . $ilDB->in('oref.ref_id', $a_ref_ids, false, 'integer');
        $set = $ilDB->query($query);
        $item_map = $item_types = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $item_map[$row['ref_id']] = $row['obj_id'];
            $item_types[$row['obj_id']] = $row['type'];
        }
 
        $a_obj_map = $item_map;
 
        // LP modes
        $db_modes = ilLPObjSettings::_lookupDBModeForObjects(array_values($item_map));
 
        $type_modes = array();
        foreach ($a_ref_ids as $ref_id) {
            $obj_id = $item_map[$ref_id];
            $type = $item_types[$obj_id];
 
            if (!ilObjectLP::isSupportedObjectType($type)) {
                $res[] = $ref_id;
                continue;
            }
 
            // use db mode
            if (array_key_exists($obj_id, $db_modes)) {
                $mode = $db_modes[$obj_id];
            }
            // use default
            else {
                if (!array_key_exists($type, $type_modes)) {
                    $type_modes[$type] = ilObjectLP::getInstance($obj_id);
                    $type_modes[$type] = $type_modes[$type]->getDefaultMode();
                }
                $mode = $type_modes[$type];
            }
 
            if ($mode == ilLPObjSettings::LP_MODE_DEACTIVATED ||
                $mode == ilLPObjSettings::LP_MODE_UNDEFINED) {
                $res[] = $ref_id;
            }
        }
        return $res;
    }

References $DIC, $ilDB, $query, $res, $type, ilLPObjSettings\_lookupDBModeForObjects(), ilObjectLP\getInstance(), ilObjectLP\isSupportedObjectType(), ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_UNDEFINED.

Referenced by lookupTimings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleNewMembership()

ilTimingsUser::handleNewMembership	(		$a_usr_id,
		ilDateTime	$sub_date
	)

Parameters

int	$a_usr_id
ilDateTime	$sub_date

Exceptions

ilDateTimeException

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

    {
        foreach ($this->getItemIds() as $item_ref_id) {
            include_once './Services/Object/classes/class.ilObjectActivation.php';
            $item = ilObjectActivation::getItem($item_ref_id);
            
            if ($item['timing_type'] != ilObjectActivation::TIMINGS_PRESETTING) {
                continue;
            }
            
            include_once './Modules/Course/classes/Timings/class.ilTimingUser.php';
            $user_item = new ilTimingUser($item['obj_id'], $a_usr_id);
            
            $user_start = clone $sub_date;
            $user_start->increment(IL_CAL_DAY, $item['suggestion_start_rel']);
            $user_item->getStart()->setDate($user_start->get(IL_CAL_UNIX), IL_CAL_UNIX);
            
            $user_end = clone $sub_date;
            $user_end->increment(IL_CAL_DAY, $item['suggestion_end_rel']);
            $user_item->getEnd()->setDate($user_end->get(IL_CAL_UNIX), IL_CAL_UNIX);
            
            $user_item->update();
        }
    }

References ilObjectActivation\getItem(), getItemIds(), IL_CAL_DAY, IL_CAL_UNIX, ilDateTime\increment(), and ilObjectActivation\TIMINGS_PRESETTING.

Here is the call graph for this function:

◆ handleUnsubscribe()

ilTimingsUser::handleUnsubscribe ( $a_usr_id )

Handle unsubscribe.

Parameters

type $a_usr_id

Definition at line 121 of file class.ilTimingsUser.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $query = 'DELETE FROM crs_timings_user WHERE ' . $ilDB->in('ref_id', $this->item_ids, false, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer');
                
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $query.

◆ init()

ilTimingsUser::init ( )

Init activation items.

Definition at line 73 of file class.ilTimingsUser.php.

    {
        if ($this->initialized) {
            return true;
        }
        $this->item_ids = $GLOBALS['tree']->getSubTreeIds($this->getContainerRefId());
        
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        ilObjectActivation::preloadData($this->item_ids);
        
        $this->initialized = true;
    }

References $GLOBALS, getContainerRefId(), and ilObjectActivation\preloadData().

Here is the call graph for this function:

◆ lookupTimings()

static ilTimingsUser::lookupTimings	(	array	$a_user_ids,
		array &	$a_meta = `null`,
			$a_only_exceeded = `true`
	)

static

Lookup references, users with exceeded timings.

Parameters

int[]	$a_user_ids
array	&$a_meta
bool	$a_only_exceeded

Returns: array

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $logger = $DIC->logger()->crs();
 
        $res = array();
        $now = time();
 
 
        // get all relevant courses
        $course_members_map = ilParticipants::getUserMembershipAssignmentsByType($a_user_ids, ['crs'], true);
        $logger->debug('Course membership assignments');
        $logger->dump($course_members_map, \ilLogLevel::DEBUG);
 
        // lookup (course) timing settings
        $query = 'SELECT crsi.obj_id sub_ref_id, oref.ref_id, oref.obj_id, crsi.suggestion_start' .
            ',crsi.suggestion_end,crsi.changeable, crss.timing_mode' .
            ' FROM crs_settings crss' .
            ' JOIN object_reference oref ON (oref.obj_id = crss.obj_id AND oref.deleted IS NULL) ' .
            ' JOIN crs_items crsi ON (crsi.parent_id = oref.ref_id)' .
            ' JOIN object_reference iref ON (crsi.obj_id = iref.ref_id AND iref.deleted IS NULL) ' .
            ' WHERE crss.view_mode = ' . $ilDB->quote(ilCourseConstants::IL_CRS_VIEW_TIMING, 'integer') .
            ' AND ' . $ilDB->in('crss.obj_id', array_keys($course_members_map), false, 'integer') .
            ' AND crsi.timing_type = ' . $ilDB->quote(ilObjectActivation::TIMINGS_PRESETTING, 'integer');
 
        $logger->debug($query);
 
        $set = $ilDB->query($query);
        $user_relevant = $course_map = $course_parent_map = [];
        while ($row = $ilDB->fetchAssoc($set)) {
            $obj_id = $row['obj_id'];
            $sub_ref_id = $row['sub_ref_id'];
            $mode = $row['timing_mode'];
 
            // needed for course_map-lookup for user-relevant data (see below)
            $course_parent_map[$row['sub_ref_id']] = $row['obj_id'];
            $course_map[$row['obj_id']] = $row['ref_id'];
 
            // gather meta data
            if (is_array($a_meta)) {
                foreach ($a_user_ids as $user_id) {
                    // only if course member
                    if (in_array($user_id, $course_members_map[$obj_id])) {
                        $a_meta[$user_id][$sub_ref_id] = array(
                            'parent' => $row['ref_id']
                        );
                    }
                }
            }
 
            // preset all users with object setting
            if ($mode == \ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE) {
                // gather meta data
                if (is_array($a_meta)) {
                    foreach ($a_user_ids as $user_id) {
                        // only if course member
                        if (in_array($user_id, $course_members_map[$obj_id])) {
                            $a_meta[$user_id][$sub_ref_id]['start'] = $row['suggestion_start'];
                            $a_meta[$user_id][$sub_ref_id]['end'] = $row['suggestion_end'];
                        }
                    }
                }
 
                if (
                    ($a_only_exceeded && ($row['suggestion_end'] && $row['suggestion_end'] < $now)) ||
                    (!$a_only_exceeded && ($row['suggestion_start'] && $row['suggestion_start'] < $now))
                ) {
                    foreach ($a_user_ids as $user_id) {
                        // only if course member
                        if (in_array($user_id, $course_members_map[$obj_id])) {
                            $res[$sub_ref_id][$user_id] = $user_id;
                        }
                    }
                }
            }
 
            // gather all objects which might have user-specific settings
            if ($row['changeable'] ||
                $mode == \ilCourseConstants::IL_CRS_VIEW_TIMING_RELATIVE) {
                $user_relevant[] = $sub_ref_id;
            }
        }
 
        if (count($user_relevant)) {
            // get user-specific data
            $query = 'SELECT * FROM crs_timings_user' .
                ' WHERE ' . $ilDB->in('usr_id', $a_user_ids, false, 'integer') .
                ' AND ' . $ilDB->in('ref_id', $user_relevant, false, 'integer');
            $set = $ilDB->query($query);
            ;
            while ($row = $ilDB->fetchAssoc($set)) {
                $ref_id = $row['ref_id'];
                $user_id = $row['usr_id'];
 
                // only if course member
                $crs_obj_id = $course_parent_map[$ref_id];
                if (!in_array($user_id, $course_members_map[$crs_obj_id])) {
                    continue;
                }
 
                // gather meta data
                if (is_array($a_meta)) {
                    $a_meta[$user_id][$ref_id]['start'] = $row['sstart'];
                    $a_meta[$user_id][$ref_id]['end'] = $row['ssend'];
                }
 
                if (
                    ($a_only_exceeded && $row['ssend'] && $row['ssend'] < $now) ||
                    (!$a_only_exceeded && $row['sstart'] && $row['sstart'] < $now)
                ) {
                    $res[$ref_id][$user_id] = $user_id;
                } else {
                    // if not exceeded remove preset data
                    unset($res[$ref_id][$user_id]);
                }
            }
        }
 
 
 
        // clean-up/minimize the result
        foreach (array_keys($res) as $ref_id) {
            if (!sizeof($res[$ref_id])) {
                if (isset($res['ref_id']) && !count($res['ref_id'])) {
                    unset($res[$ref_id]);
                } else {
                    $res[$ref_id] = array_values($res[$ref_id]);
                }
            }
        }
 
        if (isset($res) && count($res)) {
            $obj_map = array();
            $invalid_lp = self::getObjectsWithInactiveLP(array_keys($res), $obj_map);
 
            foreach (array_keys($res) as $ref_id) {
                // invalid LP?
                if (in_array($ref_id, $invalid_lp)) {
                    $res[$ref_id] = array();
                }
                // LP completed?
                else {
                    $user_ids = $res[$ref_id];
                    if (count($user_ids)) {
                        $res[$ref_id] = array_diff(
                            $user_ids,
                            ilLPStatus::_lookupCompletedForObject($obj_map[$ref_id], $user_ids)
                        );
                    }
                }
 
                // delete reference array, if no users are given anymore
                if (!sizeof($res[$ref_id])) {
                    unset($res[$ref_id]);
                }
            }
        }
 
        // #2176 - add course entries (1 exceeded sub-item is enough)
        foreach ($res as $ref_id => $user_ids) {
            // making sure one last time
            if (!count($user_ids) && isset($res['ref_id'])) {
                unset($res[$ref_id]);
            } else {
                $crs_obj_id = $course_parent_map[$ref_id];
                $crs_ref_id = $course_map[$crs_obj_id];
                if (!array_key_exists($crs_ref_id, $res)) {
                    $res[$crs_ref_id] = $user_ids;
                } else {
                    $res[$crs_ref_id] = array_unique(array_merge($user_ids, $res[$crs_ref_id]));
                }
            }
        }
        return $res;
    }

References $DIC, $ilDB, $query, $res, ilLPStatus\_lookupCompletedForObject(), ilLogLevel\DEBUG, getObjectsWithInactiveLP(), ilParticipants\getUserMembershipAssignmentsByType(), ilCourseConstants\IL_CRS_VIEW_TIMING, ilCourseConstants\IL_CRS_VIEW_TIMING_ABSOLUTE, ilCourseConstants\IL_CRS_VIEW_TIMING_RELATIVE, and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by ilTimingsCronReminder\getExceededObjectsForUser(), and ilTimingsCronReminder\getObjectsWithTimingsForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupTimingsExceededByUser()

static ilTimingsUser::lookupTimingsExceededByUser ( array $a_user_ids )

static

Check if users currently exceeded ANY object.

Parameters

int[] $a_user_ids

Returns: array

Definition at line 139 of file class.ilTimingsUser.php.

    {
        $res = array();
 
        $meta = [];
        foreach (self::lookupTimings($a_user_ids, $meta, true, true) as $user_ids) {
            foreach ($user_ids as $user_id) {
                $res[$user_id] = $user_id;
            }
        }
        return array_values($res);
    }

References $res.

Referenced by ilTimingsCronReminder\gatherUsersWithExceededTimings().

Here is the caller graph for this function:

Field Documentation

◆ $container_obj_id

ilTimingsUser::$container_obj_id = 0

private

Definition at line 16 of file class.ilTimingsUser.php.

Referenced by getContainerObjId().

◆ $container_ref_id

ilTimingsUser::$container_ref_id = 0

private

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

Referenced by getContainerRefId().

◆ $initialized

ilTimingsUser::$initialized = false

private

Definition at line 19 of file class.ilTimingsUser.php.

◆ $instances

ilTimingsUser::$instances = array()

staticprivate

Definition at line 14 of file class.ilTimingsUser.php.

◆ $item_ids

ilTimingsUser::$item_ids = array()

private

Definition at line 20 of file class.ilTimingsUser.php.

Referenced by getItemIds().

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

Modules/Course/classes/Timings/class.ilTimingsUser.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getContainerObjId()

◆ getContainerRefId()

◆ getInstanceByContainerId()

◆ getItemIds()

◆ getObjectsWithInactiveLP()

◆ handleNewMembership()

◆ handleUnsubscribe()

◆ init()

◆ lookupTimings()

◆ lookupTimingsExceededByUser()

Field Documentation

◆ $container_obj_id

◆ $container_ref_id

◆ $initialized

◆ $instances

◆ $item_ids