grommunio / grommunio-web

server/includes/notifiers/class.notifier.php

<?php

/**
 * Notifier.
 *
 * Superclass for every notifier.
 */
class Notifier {
	/**
	 * @var array list of the notifications, which is send to the client
	 */
	private $responseNotificationData;

	/**
	 * @var int notification counter of the class
	 */
	private $notifyCount;

	public function __construct() {
		$this->notifyCount = 0;
		$this->responseNotificationData = [];
	}

	/**
	 * @return Number Return the bitmask of events which are handled
	 *                by this notifier. The bitmask can consist of the
	 *                OBJECT_SAVE, OBJECT_DELETE, TABLE_SAVE, TABLE_DELETE, REQUEST_START and REQUEST_END flags
	 */
	public function getEvents() {
		return 0;
	}

	/**
	 * Function which resets the data and the response data class variable.
	 */
	public function reset() {
		$this->notifyCount = 0;
		$this->responseNotificationData = [];
	}

	/**
	 * Function which returns name of the notifier class.
	 *
	 * @return string notifier name
	 */
	public function getNotifierName() {
		return strtolower(static::class);
	}

	/**
	 * Function which adds notification data to module, so later it can be retrieved to send.
	 *
	 * @param string $actionType type of action that response data corresponds
	 * @param mixed  $data
	 */
	protected function addNotificationActionData($actionType, $data) {
		if (!isset($this->responseNotificationData[$actionType])) {
			$this->responseNotificationData[$actionType] = $data;
		}
	}

	/**
	 * Function which returns notification data that will be sent to client. If there isn't any data added
	 * to response data then it will return a blank array.
	 *
	 * @return object response data
	 */
	protected function createNotificationResponseData() {
		if (!empty($this->responseNotificationData)) {
			$moduleName = $this->getNotifierName();
			$idName = $moduleName . (++$this->notifyCount);

			$response = [
				$moduleName => [
					$idName => $this->responseNotificationData,
				],
			];

			// Clear notification data, the response which is being returned
			// should be sent to the client.
			$this->responseNotificationData = [];

			return $response;

The expression return $response returns the type array<string,array<string,array>> which is incompatible with the documented return type object.

		}

		return [];

The expression return array() returns the type array which is incompatible with the documented return type object.

	}

	/**
	 * If an event elsewhere has occurred, it enters in this method. This method
	 * executes one or more actions, depends on the event.
	 *
	 * @param int    $event   event
	 * @param string $entryid entryid
	 * @param array  $data    array of data
	 */
	public function update($event, $entryid, $data) {

The parameter $data is not used and could be removed.

The parameter $event is not used and could be removed.

The parameter $entryid is not used and could be removed.

		// you must implement this function for each notifier
	}
}