ReminderListModule::getReminders()

Complexity

Conditions	10
Paths	18

Size

Total Lines	133
Code Lines	62

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

<?php
	public function getReminders() {
		$data = [];

		$store = $GLOBALS["mapisession"]->getDefaultMessageStore();

		$restriction = [RES_AND,
			[
				[RES_PROPERTY,
					[
						RELOP => RELOP_LT,
						ULPROPTAG => $this->properties["flagdueby"],
						VALUE => [$this->properties["flagdueby"] => time()],
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_EQ,
						ULPROPTAG => $this->properties["reminder"],
						VALUE => true,
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_NE,
						ULPROPTAG => $this->properties["message_class"],
						VALUE => "IPM.TaskRequest",
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_NE,
						ULPROPTAG => $this->properties["message_class"],
						VALUE => "IPM.TaskRequest.Cancel",
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_NE,
						ULPROPTAG => $this->properties["message_class"],
						VALUE => "IPM.TaskRequest.Accept",
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_NE,
						ULPROPTAG => $this->properties["message_class"],
						VALUE => "IPM.TaskRequest.Update",
					],
				],
				[RES_PROPERTY,
					[
						RELOP => RELOP_NE,
						ULPROPTAG => $this->properties["message_class"],
						VALUE => "IPM.TaskRequest.Complete",
					],
				],
			],
		];

		try {
			$reminderfolder = mapi_msgstore_openentry($store, $this->reminderEntryId);
		}
		catch (MAPIException $e) {
			// if the reminder folder does not exist, try to recreate it.
			if ($e->getCode() == MAPI_E_NOT_FOUND) {
				$e->setHandled();

				$this->reminderEntryId = $this->createReminderFolder($store);
				$reminderfolder = mapi_msgstore_openentry($store, $this->reminderEntryId);
			}
		}

		$remindertable = mapi_folder_getcontentstable($reminderfolder, MAPI_DEFERRED_ERRORS);
		if (!$remindertable) {
			return false;
		}

		mapi_table_restrict($remindertable, $restriction, TBL_BATCH);
		mapi_table_sort($remindertable, [$this->properties["flagdueby"] => TABLE_SORT_DESCEND], TBL_BATCH);

		// reminder store hold only 99 records as
		// we show 99 notification on client side.
		$rows = mapi_table_queryrows($remindertable, $this->properties, 0, MAX_NUM_REMINDERS);
		$data["item"] = [];

		foreach ($rows as $row) {
			if (isset($row[$this->properties["appointment_recurring"]]) && $row[$this->properties["appointment_recurring"]]) {
				$recur = new Recurrence($store, $row);

The type Recurrence was not found. Maybe you did not declare it correctly or list all dependencies?

				/**
				 * FlagDueBy == PidLidReminderSignalTime.
				 * FlagDueBy handles whether we should be showing the item; if now() is after FlagDueBy, then we should show a reminder
				 * for this recurrence. However, the item we will show is either the last passed occurrence (overdue), or the next occurrence, depending
				 * on whether we have reached the next occurrence yet (the reminder_time of the next item is ignored).
				 *
				 * The way we handle this is to get all occurrences between the 'flagdueby' moment and the current time. This will
				 * yield N items (may be a lot of it was not dismissed for a long time). We can then take the last item in this list, and this is the item
				 * we will show to the user. The idea here is:
				 *
				 * The item we want to show is the last item in that list (new occurrences that have started uptil now should override old ones)
				 *
				 * Add the reminder_minutes (default 15 minutes for calendar, 0 for tasks) to check over the gap between FlagDueBy and the start time of the
				 * occurrence, if "now" would be in between these values.
				 */
				$remindertimeinseconds = $row[$this->properties["reminder_minutes"]] * 60;
				$occurrences = $recur->getItems($row[$this->properties["flagdueby"]], time() + $remindertimeinseconds, 0, true);

				if (empty($occurrences)) {
					continue;
				}

				// More than one occurrence, use the last one instead of the first one after flagdueby
				$occ = $occurrences[count($occurrences) - 1];

				// Bydefault, on occurrence reminder is true but if reminder value is set to false then we don't send popup reminder for this occurrence
				if (!(isset($occ[$this->properties['reminder']]) && $occ[$this->properties['reminder']] == 0)) {
					$row[$this->properties["reminder_time"]] = $occ[$this->properties["appointment_startdate"]];
					$row[$this->properties["appointment_startdate"]] = $occ[$this->properties["appointment_startdate"]];
					$row[$this->properties["appointment_enddate"]] = $occ[$this->properties["appointment_startdate"]];
				}
			}

			// Add the non-bogus rows
			array_push($data["item"], Conversion::mapMAPI2XML($this->properties, $row));
		}

		$this->addActionData("list", $data);
		$GLOBALS["bus"]->addData($this->getResponseData());

		// Trigger the newmailnotifier
		$GLOBALS["bus"]->notify(REQUEST_ENTRYID, HIERARCHY_UPDATE, ['', '']);

		return true;
	}