ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | Static Private Attributes
ilTimingsUser Class Reference

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.

References ilObject\_getAllReferences().

29  {
30  $this->container_obj_id = $a_container_obj_id;
31 
32  $refs = ilObject::_getAllReferences($a_container_obj_id);
33  $this->container_ref_id = end($refs);
34  }
ilObject\_getAllReferences
static _getAllReferences($a_id)
get all reference ids of object
Definition: class.ilObject.php:965
+ 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.

References $container_obj_id.

53  {
54  return $this->container_obj_id;
55  }

◆ getContainerRefId()

ilTimingsUser::getContainerRefId ( )

Get container ref_id.

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

References $container_ref_id.

Referenced by init().

61  {
62  return $this->container_ref_id;
63  }
+ 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.

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

42  {
43  if (array_key_exists($a_container_obj_id, self::$instances)) {
44  return self::$instances[$a_container_obj_id];
45  }
46  return self::$instances[$a_container_obj_id] = new self($a_container_obj_id);
47  }
+ Here is the caller graph for this function:

◆ getItemIds()

ilTimingsUser::getItemIds ( )

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

References $item_ids.

Referenced by handleNewMembership().

66  {
67  return $this->item_ids;
68  }
+ 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.

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

346  {
347  global $DIC;
348 
349  $ilDB = $DIC->database();
350 
351  $res = array();
352  $query = 'SELECT oref.ref_id, oref.obj_id, od.type' .
353  ' FROM object_reference oref' .
354  ' JOIN object_data od ON (oref.obj_id = od.obj_id)' .
355  ' WHERE ' . $ilDB->in('oref.ref_id', $a_ref_ids, false, 'integer');
356  $set = $ilDB->query($query);
357  $item_map = $item_types = array();
358  while ($row = $ilDB->fetchAssoc($set)) {
359  $item_map[$row['ref_id']] = $row['obj_id'];
360  $item_types[$row['obj_id']] = $row['type'];
361  }
362 
363  $a_obj_map = $item_map;
364 
365  // LP modes
366  $db_modes = ilLPObjSettings::_lookupDBModeForObjects(array_values($item_map));
367 
368  $type_modes = array();
369  foreach ($a_ref_ids as $ref_id) {
370  $obj_id = $item_map[$ref_id];
371  $type = $item_types[$obj_id];
372 
373  if (!ilObjectLP::isSupportedObjectType($type)) {
374  $res[] = $ref_id;
375  continue;
376  }
377 
378  // use db mode
379  if (array_key_exists($obj_id, $db_modes)) {
380  $mode = $db_modes[$obj_id];
381  }
382  // use default
383  else {
384  if (!array_key_exists($type, $type_modes)) {
385  $type_modes[$type] = ilObjectLP::getInstance($obj_id);
386  $type_modes[$type] = $type_modes[$type]->getDefaultMode();
387  }
388  $mode = $type_modes[$type];
389  }
390 
391  if ($mode == ilLPObjSettings::LP_MODE_DEACTIVATED ||
392  $mode == ilLPObjSettings::LP_MODE_UNDEFINED) {
393  $res[] = $ref_id;
394  }
395  }
396  return $res;
397  }
$type
$type
Definition: proxy_ylocal.php:10
$DIC
global $DIC
Definition: saml.php:7
ilObjectLP\isSupportedObjectType
static isSupportedObjectType($a_type)
Definition: class.ilObjectLP.php:150
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15
$query
$query
Definition: proxy_ylocal.php:13
ilLPObjSettings\_lookupDBModeForObjects
static _lookupDBModeForObjects(array $a_obj_ids)
Definition: class.ilLPObjSettings.php:296
$row
$row
Definition: migrateto20.php:360
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:45
+ Here is the call 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.

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

93  {
94  foreach ($this->getItemIds() as $item_ref_id) {
95  include_once './Services/Object/classes/class.ilObjectActivation.php';
96  $item = ilObjectActivation::getItem($item_ref_id);
97 
98  if ($item['timing_type'] != ilObjectActivation::TIMINGS_PRESETTING) {
99  continue;
100  }
101 
102  include_once './Modules/Course/classes/Timings/class.ilTimingUser.php';
103  $user_item = new ilTimingUser($item['obj_id'], $a_usr_id);
104 
105  $user_start = clone $sub_date;
106  $user_start->increment(IL_CAL_DAY, $item['suggestion_start_rel']);
107  $user_item->getStart()->setDate($user_start->get(IL_CAL_UNIX), IL_CAL_UNIX);
108 
109  $user_end = clone $sub_date;
110  $user_end->increment(IL_CAL_DAY, $item['suggestion_end_rel']);
111  $user_item->getEnd()->setDate($user_end->get(IL_CAL_UNIX), IL_CAL_UNIX);
112 
113  $user_item->update();
114  }
115  }
ilTimingUser
TableGUI class for timings administration.
Definition: class.ilTimingUser.php:12
ilObjectActivation\getItem
static getItem($a_ref_id)
Get item data.
Definition: class.ilObjectActivation.php:354
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
IL_CAL_DAY
const IL_CAL_DAY
Definition: class.ilDateTime.php:20
ilDateTime\increment
increment($a_type, $a_count=1)
increment
Definition: class.ilDateTime.php:273
+ 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.

References $DIC, $ilDB, and $query.

122  {
123  global $DIC;
124 
125  $ilDB = $DIC->database();
126 
127  $query = 'DELETE FROM crs_timings_user WHERE ' . $ilDB->in('ref_id', $this->item_ids, false, 'integer') . ' ' .
128  'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer');
129 
130  $ilDB->manipulate($query);
131  }
$DIC
global $DIC
Definition: saml.php:7
$query
$query
Definition: proxy_ylocal.php:13
$ilDB
global $ilDB
Definition: storeScorm2004.php:16

◆ init()

ilTimingsUser::init ( )

Init activation items.

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

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

74  {
75  if ($this->initialized) {
76  return true;
77  }
78  $this->item_ids = $GLOBALS['tree']->getSubTreeIds($this->getContainerRefId());
79 
80  include_once './Services/Object/classes/class.ilObjectActivation.php';
81  ilObjectActivation::preloadData($this->item_ids);
82 
83  $this->initialized = true;
84  }
ilObjectActivation\preloadData
static preloadData(array $a_ref_ids)
Preload data to internal cache.
Definition: class.ilObjectActivation.php:334
ilTimingsUser\getContainerRefId
getContainerRefId()
Get container ref_id.
Definition: class.ilTimingsUser.php:60
$GLOBALS
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.
Definition: module.tag.xmp.php:702
+ 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.

References $DIC, $ilDB, $query, $res, $row, ilLPStatus\_lookupCompletedForObject(), ilLogLevel\DEBUG, 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().

161  {
162  global $DIC;
163 
164  $ilDB = $DIC->database();
165  $logger = $DIC->logger()->crs();
166 
167  $res = array();
168  $now = time();
169 
170 
171  // get all relevant courses
172  $course_members_map = ilParticipants::getUserMembershipAssignmentsByType($a_user_ids, ['crs'], true);
173  $logger->debug('Course membership assignments');
174  $logger->dump($course_members_map, \ilLogLevel::DEBUG);
175 
176  // lookup (course) timing settings
177  $query = 'SELECT crsi.obj_id sub_ref_id, oref.ref_id, oref.obj_id, crsi.suggestion_start' .
178  ',crsi.suggestion_end,crsi.changeable, crss.timing_mode' .
179  ' FROM crs_settings crss' .
180  ' JOIN object_reference oref ON (oref.obj_id = crss.obj_id AND oref.deleted IS NULL) ' .
181  ' JOIN crs_items crsi ON (crsi.parent_id = oref.ref_id)' .
182  ' JOIN object_reference iref ON (crsi.obj_id = iref.ref_id AND iref.deleted IS NULL) ' .
183  ' WHERE crss.view_mode = ' . $ilDB->quote(ilCourseConstants::IL_CRS_VIEW_TIMING, 'integer') .
184  ' AND ' . $ilDB->in('crss.obj_id', array_keys($course_members_map), false, 'integer') .
185  ' AND crsi.timing_type = ' . $ilDB->quote(ilObjectActivation::TIMINGS_PRESETTING, 'integer');
186 
187  $logger->debug($query);
188 
189  $set = $ilDB->query($query);
190  $user_relevant = $course_map = $course_parent_map = [];
191  while ($row = $ilDB->fetchAssoc($set)) {
192  $obj_id = $row['obj_id'];
193  $sub_ref_id = $row['sub_ref_id'];
194  $mode = $row['timing_mode'];
195 
196  // needed for course_map-lookup for user-relevant data (see below)
197  $course_parent_map[$row['sub_ref_id']] = $row['obj_id'];
198  $course_map[$row['obj_id']] = $row['ref_id'];
199 
200  // gather meta data
201  if (is_array($a_meta)) {
202  foreach ($a_user_ids as $user_id) {
203  // only if course member
204  if (in_array($user_id, $course_members_map[$obj_id])) {
205  $a_meta[$user_id][$sub_ref_id] = array(
206  'parent' => $row['ref_id']
207  );
208  }
209  }
210  }
211 
212  // preset all users with object setting
213  if ($mode == \ilCourseConstants::IL_CRS_VIEW_TIMING_ABSOLUTE) {
214  // gather meta data
215  if (is_array($a_meta)) {
216  foreach ($a_user_ids as $user_id) {
217  // only if course member
218  if (in_array($user_id, $course_members_map[$obj_id])) {
219  $a_meta[$user_id][$sub_ref_id]['start'] = $row['suggestion_start'];
220  $a_meta[$user_id][$sub_ref_id]['end'] = $row['suggestion_end'];
221  }
222  }
223  }
224 
225  if (
226  ($a_only_exceeded && ($row['suggestion_end'] && $row['suggestion_end'] < $now)) ||
227  (!$a_only_exceeded && ($row['suggestion_start'] && $row['suggestion_start'] < $now))
228  ) {
229  foreach ($a_user_ids as $user_id) {
230  // only if course member
231  if (in_array($user_id, $course_members_map[$obj_id])) {
232  $res[$sub_ref_id][$user_id] = $user_id;
233  }
234  }
235  }
236  }
237 
238  // gather all objects which might have user-specific settings
239  if ($row['changeable'] ||
240  $mode == \ilCourseConstants::IL_CRS_VIEW_TIMING_RELATIVE) {
241  $user_relevant[] = $sub_ref_id;
242  }
243  }
244 
245  if (count($user_relevant)) {
246  // get user-specific data
247  $query = 'SELECT * FROM crs_timings_user' .
248  ' WHERE ' . $ilDB->in('usr_id', $a_user_ids, false, 'integer') .
249  ' AND ' . $ilDB->in('ref_id', $user_relevant, false, 'integer');
250  $set = $ilDB->query($query);
251  ;
252  while ($row = $ilDB->fetchAssoc($set)) {
253  $ref_id = $row['ref_id'];
254  $user_id = $row['usr_id'];
255 
256  // only if course member
257  $crs_obj_id = $course_parent_map[$ref_id];
258  if (!in_array($user_id, $course_members_map[$crs_obj_id])) {
259  continue;
260  }
261 
262  // gather meta data
263  if (is_array($a_meta)) {
264  $a_meta[$user_id][$ref_id]['start'] = $row['sstart'];
265  $a_meta[$user_id][$ref_id]['end'] = $row['ssend'];
266  }
267 
268  if (
269  ($a_only_exceeded && $row['ssend'] && $row['ssend'] < $now) ||
270  (!$a_only_exceeded && $row['sstart'] && $row['sstart'] < $now)
271  ) {
272  $res[$ref_id][$user_id] = $user_id;
273  } else {
274  // if not exceeded remove preset data
275  unset($res[$ref_id][$user_id]);
276  }
277  }
278  }
279 
280 
281 
282  // clean-up/minimize the result
283  foreach (array_keys($res) as $ref_id) {
284  if (!sizeof($res[$ref_id])) {
285  if (isset($res['ref_id']) && !count($res['ref_id'])) {
286  unset($res[$ref_id]);
287  } else {
288  $res[$ref_id] = array_values($res[$ref_id]);
289  }
290  }
291  }
292 
293  if (isset($res) && count($res)) {
294  $obj_map = array();
295  $invalid_lp = self::getObjectsWithInactiveLP(array_keys($res), $obj_map);
296 
297  foreach (array_keys($res) as $ref_id) {
298  // invalid LP?
299  if (in_array($ref_id, $invalid_lp)) {
300  $res[$ref_id] = array();
301  }
302  // LP completed?
303  else {
304  $user_ids = $res[$ref_id];
305  if (count($user_ids)) {
306  $res[$ref_id] = array_diff(
307  $user_ids,
308  ilLPStatus::_lookupCompletedForObject($obj_map[$ref_id], $user_ids)
309  );
310  }
311  }
312 
313  // delete reference array, if no users are given anymore
314  if (!sizeof($res[$ref_id])) {
315  unset($res[$ref_id]);
316  }
317  }
318  }
319 
320  // #2176 - add course entries (1 exceeded sub-item is enough)
321  foreach ($res as $ref_id => $user_ids) {
322  // making sure one last time
323  if (!count($user_ids) && isset($res['ref_id'])) {
324  unset($res[$ref_id]);
325  } else {
326  $crs_obj_id = $course_parent_map[$ref_id];
327  $crs_ref_id = $course_map[$crs_obj_id];
328  if (!array_key_exists($crs_ref_id, $res)) {
329  $res[$crs_ref_id] = $user_ids;
330  } else {
331  $res[$crs_ref_id] = array_unique(array_merge($user_ids, $res[$crs_ref_id]));
332  }
333  }
334  }
335  return $res;
336  }
$DIC
global $DIC
Definition: saml.php:7
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15
$query
$query
Definition: proxy_ylocal.php:13
$row
$row
Definition: migrateto20.php:360
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilLPStatus\_lookupCompletedForObject
static _lookupCompletedForObject($a_obj_id, $a_user_ids=null)
Get completed users for object.
Definition: class.ilLPStatus.php:704
ilParticipants\getUserMembershipAssignmentsByType
static getUserMembershipAssignmentsByType($a_user_ids, $a_type, $a_only_member_roles)
Get user membership assignments by type.
Definition: class.ilParticipants.php:207
+ 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.

References $res.

Referenced by ilTimingsCronReminder\gatherUsersWithExceededTimings().

140  {
141  $res = array();
142 
143  $meta = [];
144  foreach (self::lookupTimings($a_user_ids, $meta, true, true) as $user_ids) {
145  foreach ($user_ids as $user_id) {
146  $res[$user_id] = $user_id;
147  }
148  }
149  return array_values($res);
150  }
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15
+ 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: