Manage data for ilMembershipCronNotifications cron job. More...

Collaboration diagram for ilMembershipCronNotificationsData:

Public Member Functions
	__construct (int $last_run, string $cron_id)

	getAggregatedNews ()
	Get aggregated news. More...

	getLikes (int $news_id, int $user_id)
	Get likes for a news and user. More...

	getComments (int $news_id, int $user_id)
	Get comments for a news and user. More...

Protected Member Functions
	load ()
	Load. More...

	checkMissingNews (int $user_id, int $ref_id, int $news_id)
	Get missing news*. More...

	loadMissingNews ()
	Load missing news (news for new likes and/or comments) More...

	getObjectsForRefId (int $a_ref_id)
	Get subtree object IDs for ref id. More...

	ping ()
	Ping. More...

Protected Attributes
Service	$notes

int	$last_run_unix

string	$last_run_date

string	$cron_id

ilLogger	$log

array	$objects = []

array	$news = []

array	$news_per_user = []

array	$user_news_aggr = []
	news array (may include aggregated news which contains news as subitems) More...

array	$likes = []

array	$comments = []

array	$missing_news_per_user = []

array	$missing_news = []

ilAccessHandler	$access

Detailed Description

Manage data for ilMembershipCronNotifications cron job.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilMembershipCronNotificationsData::__construct	(	int	$last_run,
		string	$cron_id
	)

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

References $cron_id, $DIC, ILIAS\Repository\access(), ilLoggerFactory\getLogger(), and load().

     {
         global $DIC;
 
         $this->access = $DIC->access();
 
         $this->last_run_unix = $last_run;
         $this->last_run_date = date('Y-m-d H:i:s', $last_run);
         $this->cron_id = $cron_id;
         $this->log = ilLoggerFactory::getLogger("mmbr");
         $this->notes = $DIC->notes();
         $this->load();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkMissingNews()

ilMembershipCronNotificationsData::checkMissingNews	(	int	$user_id,
		int	$ref_id,
		int	$news_id
	)

protected

Get missing news*.

Definition at line 219 of file class.ilMembershipCronNotificationsData.php.

References $ref_id, $user_id, and null.

Referenced by load().

                                                                                 : void
     {
         $this->log->debug("Check missing news: " . $user_id . "-" . $ref_id . "-" . $news_id);
         if (!is_array($this->news_per_user[$user_id][$ref_id] ?? null) ||
             !in_array($news_id, $this->news_per_user[$user_id][$ref_id])) {
             $this->log->debug("Add missing news: " . $news_id);
             $this->missing_news[$news_id] = $news_id;
             $this->missing_news_per_user[$user_id][$ref_id][$news_id] = $news_id;
         }
     }

Here is the caller graph for this function:

◆ getAggregatedNews()

ilMembershipCronNotificationsData::getAggregatedNews ( )

Get aggregated news.

Definition at line 297 of file class.ilMembershipCronNotificationsData.php.

References $user_news_aggr.

                                        : array
     {
         return $this->user_news_aggr;
     }

◆ getComments()

ilMembershipCronNotificationsData::getComments	(	int	$news_id,
		int	$user_id
	)

Get comments for a news and user.

Definition at line 316 of file class.ilMembershipCronNotificationsData.php.

References $user_id.

                                                            : array
     {
         if (isset($this->comments[$user_id][$news_id])) {
             return $this->comments[$user_id][$news_id];
         }
         return [];
     }

◆ getLikes()

ilMembershipCronNotificationsData::getLikes	(	int	$news_id,
		int	$user_id
	)

Get likes for a news and user.

Definition at line 305 of file class.ilMembershipCronNotificationsData.php.

References $user_id.

                                                         : array
     {
         if (isset($this->likes[$user_id][$news_id])) {
             return $this->likes[$user_id][$news_id];
         }
         return [];
     }

◆ getObjectsForRefId()

ilMembershipCronNotificationsData::getObjectsForRefId ( int $a_ref_id )

protected

Get subtree object IDs for ref id.

Definition at line 255 of file class.ilMembershipCronNotificationsData.php.

References $DIC.

Referenced by load().

                                                         : array
     {
         global $DIC;
 
         $tree = $DIC->repositoryTree();
         $nodes = array();
 
         if (!$tree->isDeleted($a_ref_id)) {
             // parse repository branch of group
 
             $node = $tree->getNodeData($a_ref_id);
             foreach ($tree->getSubTree($node) as $child) {
                 if ($child["type"] !== "rolf") {
                     $nodes["obj_id"][$child["obj_id"]] = array(
                         "obj_id" => $child["obj_id"],
                         "type" => $child["type"]
                     );
                     $nodes["ref_id"][$child["child"]] = array(
                         "ref_id" => $child["child"],
                         "obj_id" => $child["obj_id"],
                         "type" => $child["type"]
                     );
                 }
             }
         }
 
         return $nodes;
     }

Here is the caller graph for this function:

◆ load()

ilMembershipCronNotificationsData::load ( )

protected

Load.

Definition at line 76 of file class.ilMembershipCronNotificationsData.php.

References $access, $c, $ref_id, $user_id, checkMissingNews(), ilMembershipNotifications\getActiveUsersforAllObjects(), getObjectsForRefId(), loadMissingNews(), and ping().

Referenced by __construct().

                              : void
     {
         $ilAccess = $this->access;
 
         // all group/course notifications: ref id => user ids
         $this->objects = ilMembershipNotifications::getActiveUsersforAllObjects();
 
         if (count($this->objects)) {
             $this->log->debug("nr of objects: " . count($this->objects));
 
             // gather news for each user over all objects
             $this->user_news_aggr = array();
 
             foreach ($this->objects as $ref_id => $user_ids) {
                 $this->log->debug("handle ref id " . $ref_id . ", users: " . count($user_ids));
                 $this->log->debug("last run unix: " . $this->last_run_unix);
                 $this->log->debug("last run date: " . $this->last_run_date);
                 // gather news per object
                 $news_item = new ilNewsItem();
                 $objs = $this->getObjectsForRefId($ref_id);
                 if (
                     isset($objs["obj_id"]) &&
                     is_array($objs["obj_id"]) &&
                     $news_item->checkNewsExistsForObjects($objs["obj_id"], $this->last_run_date)
                 ) {
                     $this->log->debug("Got news");
                     foreach ($user_ids as $user_id) {
                         // gather news for user
                         $user_news = $news_item->getNewsForRefId(
                             $ref_id,
                             false,
                             false,
                             $this->last_run_date,
                             false,
                             false,
                             false,
                             false,
                             $user_id
                         );
                         if ($user_news) {
                             $this->user_news_aggr[$user_id][$ref_id] = $user_news;
 
                             // store all single news
                             foreach ($this->user_news_aggr as $agg_news) {
                                 if (isset($agg_news["aggregation"]) && is_array($agg_news["aggregation"]) && $agg_news["aggregation"] !== []) {
                                     foreach ($agg_news["aggregation"] as $n) {
                                         $this->news[$n["id"]] = $n;
                                         $this->news_per_user[$user_id][$ref_id][$n["id"]] = $n["id"];
                                     }
                                 } elseif (is_array($agg_news)) {
                                     if (isset($agg_news["id"])) {
                                         $this->news[$agg_news["id"]] = $agg_news;
                                         $this->news_per_user[$user_id][$ref_id][$agg_news["id"]] = $agg_news["id"];
                                     } else {
                                         foreach ($agg_news as $agg_news_items) {
                                             foreach ($agg_news_items as $agg_news_item) {
                                                 if (isset($agg_news_item["id"])) {
                                                     $this->news[$agg_news_item["id"]] = $agg_news_item;
                                                     $this->news_per_user[$user_id][$ref_id][$agg_news_item["id"]] = $agg_news_item["id"];
                                                 }
                                             }
                                         }
                                     }
                                 }
                             }
 
                             $this->ping();
                         }
                     }
                 } else {
                     $this->log->debug("Got no news");
                 }
 
                 // gather likes per object and store them "per news item"
                 // currently only news can be liked
                 $ref_for_obj_id = array();
                 foreach ($objs["ref_id"] as $i) {
                     $ref_for_obj_id[$i["obj_id"]][$i["ref_id"]] = $i["ref_id"];
                 }
                 $like_data = new ilLikeData(array_keys($objs["obj_id"]));
                 foreach (array_keys($objs["obj_id"]) as $obj_id) {
                     $this->log->debug("Get like data for obj_id: " . $obj_id);
                     foreach ($like_data->getExpressionEntriesForObject($obj_id, $this->last_run_date) as $like) {
                         reset($user_ids);
                         foreach ($user_ids as $user_id) {
                             $has_perm = false;
                             foreach ($ref_for_obj_id[$obj_id] as $perm_ref_id) {
                                 if ($ilAccess->checkAccessOfUser($user_id, "read", "", (int) $perm_ref_id)) {
                                     $has_perm = true;
                                     break;
                                 }
                             }
                             if ($has_perm) {
                                 $this->likes[$user_id][$like["news_id"]][] = $like;
 
                                 // get news data for news that are not included above
                                 $this->checkMissingNews($user_id, $ref_id, $like["news_id"]);
                                 $this->ping();
                             }
                         }
                     }
                 }
 
                 // gather comments
                 foreach (array_keys($objs["obj_id"]) as $obj_id) {
                     $coms = $this->notes
                         ->domain()
                         ->getAllCommentsForObjId(
                             $obj_id,
                             $this->last_run_date
                         );
                     foreach ($coms as $c) {
                         $comment_context = $c->getContext();
                         if ($comment_context->getNewsId() === 0) {
                             continue;
                         }
                         reset($user_ids);
                         foreach ($user_ids as $user_id) {
                             $has_perm = false;
                             foreach ($ref_for_obj_id[$obj_id] as $perm_ref_id) {
                                 if ($ilAccess->checkAccessOfUser($user_id, "read", "", (int) $perm_ref_id)) {
                                     $has_perm = true;
                                     break;
                                 }
                             }
                             if ($has_perm) {
                                 $this->comments[$user_id][$comment_context->getNewsId()][] = $c;
 
                                 // get news data for news that are not included above
                                 $this->checkMissingNews($user_id, $ref_id, $comment_context->getNewsId());
                                 $this->ping();
                             }
                         }
                     }
                 }
             }
             $this->loadMissingNews();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadMissingNews()

ilMembershipCronNotificationsData::loadMissingNews ( )

protected

Load missing news (news for new likes and/or comments)

Definition at line 233 of file class.ilMembershipCronNotificationsData.php.

References $news, $r, $ref_id, $user_id, and ilNewsItem\queryNewsByIds().

Referenced by load().

                                         : void
     {
         foreach (ilNewsItem::queryNewsByIds($this->missing_news) as $news) {
             $this->log->debug("Got missing news: " . $news["id"]);
             $this->news[$news["id"]] = $news;
         }
         foreach ($this->missing_news_per_user as $user_id => $r) {
             foreach ($r as $ref_id => $n) {
                 foreach ($n as $news_id) {
                     $this->log->debug("Load missing news: " . $user_id . "-" . $ref_id . "-" . $news_id);
                     if (isset($this->news[$news_id])) {
                         $this->user_news_aggr[$user_id][$ref_id][$news_id] = $this->news[$news_id];
                         $this->news_per_user[$user_id][$ref_id][$news_id] = $news_id;
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ping()

ilMembershipCronNotificationsData::ping ( )

protected

Ping.

Definition at line 287 of file class.ilMembershipCronNotificationsData.php.

References $DIC.

Referenced by load().

                              : void
     {
         global $DIC;
 
         $DIC->cron()->manager()->ping($this->cron_id);
     }

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilMembershipCronNotificationsData::$access

protected

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

Referenced by load().

◆ $comments

array ilMembershipCronNotificationsData::$comments = []

protected

Definition at line 53 of file class.ilMembershipCronNotificationsData.php.

◆ $cron_id

string ilMembershipCronNotificationsData::$cron_id

protected

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

Referenced by __construct().

◆ $last_run_date

string ilMembershipCronNotificationsData::$last_run_date

protected

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

◆ $last_run_unix

int ilMembershipCronNotificationsData::$last_run_unix

protected

Todo:: convert to DateTime

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

◆ $likes

array ilMembershipCronNotificationsData::$likes = []

protected

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

◆ $log

ilLogger ilMembershipCronNotificationsData::$log

protected

Definition at line 39 of file class.ilMembershipCronNotificationsData.php.

◆ $missing_news

array ilMembershipCronNotificationsData::$missing_news = []

protected

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

◆ $missing_news_per_user

array ilMembershipCronNotificationsData::$missing_news_per_user = []

protected

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

◆ $news

array ilMembershipCronNotificationsData::$news = []

protected

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

Referenced by loadMissingNews().

◆ $news_per_user

array ilMembershipCronNotificationsData::$news_per_user = []

protected

Definition at line 46 of file class.ilMembershipCronNotificationsData.php.

◆ $notes

Service ilMembershipCronNotificationsData::$notes

protected

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

◆ $objects

array ilMembershipCronNotificationsData::$objects = []

protected

Definition at line 40 of file class.ilMembershipCronNotificationsData.php.

◆ $user_news_aggr

array ilMembershipCronNotificationsData::$user_news_aggr = []

protected

news array (may include aggregated news which contains news as subitems)

Definition at line 51 of file class.ilMembershipCronNotificationsData.php.

Referenced by getAggregatedNews().

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

components/ILIAS/Membership/classes/Cron/class.ilMembershipCronNotificationsData.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkMissingNews()

◆ getAggregatedNews()

◆ getComments()

◆ getLikes()

◆ getObjectsForRefId()

◆ load()

◆ loadMissingNews()

◆ ping()

Field Documentation

◆ $access

◆ $comments

◆ $cron_id

◆ $last_run_date

◆ $last_run_unix

◆ $likes

◆ $log

◆ $missing_news

◆ $missing_news_per_user

◆ $news

◆ $news_per_user

◆ $notes

◆ $objects

◆ $user_news_aggr