summaryrefslogtreecommitdiff
path: root/app/Model/Notification.php
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-10-17 09:51:15 -0400
committerFrederic Guillot <fred@kanboard.net>2015-10-17 09:51:15 -0400
commit73a5b9bc75d40a30e7c9674b292957657ac01f63 (patch)
treeff5bb8a90452a2ff1351c192575e5d241a8b4417 /app/Model/Notification.php
parent98b203fe691ec1ea9d6d19e916827185b575b05a (diff)
Make user notifications pluggable
Diffstat (limited to 'app/Model/Notification.php')
-rw-r--r--app/Model/Notification.php187
1 files changed, 0 insertions, 187 deletions
diff --git a/app/Model/Notification.php b/app/Model/Notification.php
deleted file mode 100644
index 692f37a7..00000000
--- a/app/Model/Notification.php
+++ /dev/null
@@ -1,187 +0,0 @@
-<?php
-
-namespace Kanboard\Model;
-
-use Kanboard\Core\Translator;
-
-/**
- * Notification model
- *
- * @package model
- * @author Frederic Guillot
- */
-class Notification extends Base
-{
- /**
- * Send notifications to people
- *
- * @access public
- * @param string $event_name
- * @param array $event_data
- */
- public function sendNotifications($event_name, array $event_data)
- {
- $logged_user_id = $this->userSession->isLogged() ? $this->userSession->getId() : 0;
- $users = $this->notification->getUsersWithNotificationEnabled($event_data['task']['project_id'], $logged_user_id);
-
- if (! empty($users)) {
-
- foreach ($users as $user) {
- if ($this->notificationFilter->shouldReceiveNotification($user, $event_data)) {
- $this->sendUserNotification($user, $event_name, $event_data);
- }
- }
-
- // Restore locales
- $this->config->setupTranslations();
- }
- }
-
- /**
- * Send notification to someone
- *
- * @access public
- * @param array $user User
- * @param string $event_name
- * @param array $event_data
- */
- public function sendUserNotification(array $user, $event_name, array $event_data)
- {
- Translator::unload();
-
- // Use the user language otherwise use the application language (do not use the session language)
- if (! empty($user['language'])) {
- Translator::load($user['language']);
- }
- else {
- Translator::load($this->config->get('application_language', 'en_US'));
- }
-
- foreach ($this->notificationType->getUserSelectedTypes($user['id']) as $type) {
- $className = strtolower($type).'Notification';
- $this->$className->send($user, $event_name, $event_data);
- }
- }
-
- /**
- * Get a list of people with notifications enabled
- *
- * @access public
- * @param integer $project_id Project id
- * @param integer $exclude_user_id User id to exclude
- * @return array
- */
- public function getUsersWithNotificationEnabled($project_id, $exclude_user_id = 0)
- {
- if ($this->projectPermission->isEverybodyAllowed($project_id)) {
- return $this->getEverybodyWithNotificationEnabled($exclude_user_id);
- }
-
- return $this->getProjectMembersWithNotificationEnabled($project_id, $exclude_user_id);
- }
-
- /**
- * Enable notification for someone
- *
- * @access public
- * @param integer $user_id
- * @return boolean
- */
- public function enableNotification($user_id)
- {
- return $this->db->table(User::TABLE)->eq('id', $user_id)->update(array('notifications_enabled' => 1));
- }
-
- /**
- * Disable notification for someone
- *
- * @access public
- * @param integer $user_id
- * @return boolean
- */
- public function disableNotification($user_id)
- {
- return $this->db->table(User::TABLE)->eq('id', $user_id)->update(array('notifications_enabled' => 0));
- }
-
- /**
- * Save settings for the given user
- *
- * @access public
- * @param integer $user_id User id
- * @param array $values Form values
- */
- public function saveSettings($user_id, array $values)
- {
- $this->db->startTransaction();
-
- if (isset($values['notifications_enabled']) && $values['notifications_enabled'] == 1) {
- $this->enableNotification($user_id);
-
- $filter = empty($values['notifications_filter']) ? NotificationFilter::FILTER_BOTH : $values['notifications_filter'];
- $projects = empty($values['notification_projects']) ? array() : array_keys($values['notification_projects']);
- $types = empty($values['notification_types']) ? array() : array_keys($values['notification_types']);
-
- $this->notificationFilter->saveUserFilter($user_id, $filter);
- $this->notificationFilter->saveUserSelectedProjects($user_id, $projects);
- $this->notificationType->saveUserSelectedTypes($user_id, $types);
- }
- else {
- $this->disableNotification($user_id);
- }
-
- $this->db->closeTransaction();
- }
-
- /**
- * Read user settings to display the form
- *
- * @access public
- * @param integer $user_id User id
- * @return array
- */
- public function readSettings($user_id)
- {
- $values = $this->db->table(User::TABLE)->eq('id', $user_id)->columns('notifications_enabled', 'notifications_filter')->findOne();
- $values['notification_types'] = $this->notificationType->getUserSelectedTypes($user_id);
- $values['notification_projects'] = $this->notificationFilter->getUserSelectedProjects($user_id);
- return $values;
- }
-
- /**
- * Get a list of project members with notification enabled
- *
- * @access private
- * @param integer $project_id Project id
- * @param integer $exclude_user_id User id to exclude
- * @return array
- */
- private function getProjectMembersWithNotificationEnabled($project_id, $exclude_user_id)
- {
- return $this->db
- ->table(ProjectPermission::TABLE)
- ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language', User::TABLE.'.notifications_filter')
- ->join(User::TABLE, 'id', 'user_id')
- ->eq('project_id', $project_id)
- ->eq('notifications_enabled', '1')
- ->neq(User::TABLE.'.id', $exclude_user_id)
- ->findAll();
- }
-
- /**
- * Get a list of project members with notification enabled
- *
- * @access private
- * @param integer $exclude_user_id User id to exclude
- * @return array
- */
- private function getEverybodyWithNotificationEnabled($exclude_user_id)
- {
- return $this->db
- ->table(User::TABLE)
- ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name', User::TABLE.'.email', User::TABLE.'.language', User::TABLE.'.notifications_filter')
- ->eq('notifications_enabled', '1')
- ->neq(User::TABLE.'.id', $exclude_user_id)
- ->findAll();
- }
-}