Skip to content

Commit

Permalink
Allow notifications limit to be passed to getNotifications()
Browse files Browse the repository at this point in the history 
Change `getNotifications()` method to accept a 3rd parementer for $limit and make code changes to pull from DB
  • Loading branch information
@akkaweb
akkaweb committed Mar 23, 2016
1 parent afafe4f commit 413dd9e
Showing 1 changed file with 185 additions and 185 deletions.
370 changes: 185 additions & 185 deletions src/Controller/Component/NotifierComponent.php
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/**
* CakeManager (http://cakemanager.org)
* Copyright (c) http://cakemanager.org
Expand All @@ -12,6 +13,7 @@
* @since 1.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/

namespace Notifier\Controller\Component;

use Cake\Controller\Component;
Expand All @@ -24,200 +26,198 @@
/**
* Notifier component
*/
class NotifierComponent extends Component
{
/**
* Default configuration.
*
* @var array
*/
protected $_defaultConfig = [
'UsersModel' => 'Users'
];

/**
* The controller.
*
* @var \Cake\Controller\Controller
*/
private $Controller = null;

/**
* initialize
*
* @param array $config Config.
* @return void
*/
public function initialize(array $config)
{
parent::initialize($config);

$this->Controller = $this->_registry->getController();
class NotifierComponent extends Component {

/**
* Default configuration.
*
* @var array
*/
protected $_defaultConfig = [
'UsersModel' => 'Users'
];

/**
* The controller.
*
* @var \Cake\Controller\Controller
*/
private $Controller = null;

/**
* initialize
*
* @param array $config Config.
* @return void
*/
public function initialize(array $config) {
parent::initialize($config);

$this->Controller = $this->_registry->getController();
}

/**
* setController
*
* Setter for the Controller property.
*
* @param \Cake\Controller\Controller $controller Controller.
* @return void
*/
public function setController($controller) {
$this->Controller = $controller;
}

/**
* getNotifications
*
* Returns a list of notifications.
*
* ### Examples
* ```
* // if the user is logged in, this is the way to get all notifications
* $this->Notifier->getNotifications();
*
* // for a specific user, use the first parameter for the user_id
* $this->Notifier->getNotifications(1);
*
* // default all notifications are returned. Use the second parameter to define read / unread:
*
* // get all unread notifications
* $this->Notifier->getNotifications(1, true);
*
* // get all read notifications
* $this->Notifier->getNotifications(1, false);
* ```
* @param int|null $userId Id of the user.
* @param bool|null $state The state of notifications: `true` for unread, `false` for read, `null` for all.
* @return array
*/
public function getNotifications($userId = null, $state = null, $limit = null) {
if (!$userId) {
$userId = $this->Controller->Auth->user('id');
}

/**
* setController
*
* Setter for the Controller property.
*
* @param \Cake\Controller\Controller $controller Controller.
* @return void
*/
public function setController($controller)
{
$this->Controller = $controller;
$model = TableRegistry::get('Notifier.Notifications');

$query = $model->find()->where(['Notifications.user_id' => $userId])->order(['created' => 'desc']);

if (!is_null($state)) {
$query->where(['Notifications.state' => $state]);
}

/**
* getNotifications
*
* Returns a list of notifications.
*
* ### Examples
* ```
* // if the user is logged in, this is the way to get all notifications
* $this->Notifier->getNotifications();
*
* // for a specific user, use the first parameter for the user_id
* $this->Notifier->getNotifications(1);
*
* // default all notifications are returned. Use the second parameter to define read / unread:
*
* // get all unread notifications
* $this->Notifier->getNotifications(1, true);
*
* // get all read notifications
* $this->Notifier->getNotifications(1, false);
* ```
* @param int|null $userId Id of the user.
* @param bool|null $state The state of notifications: `true` for unread, `false` for read, `null` for all.
* @return array
*/
public function getNotifications($userId = null, $state = null)
{
if (!$userId) {
$userId = $this->Controller->Auth->user('id');
}

$model = TableRegistry::get('Notifier.Notifications');

$query = $model->find()->where(['Notifications.user_id' => $userId])->order(['created' => 'desc']);

if (!is_null($state)) {
$query->where(['Notifications.state' => $state]);
}

return $query->toArray();
if (!is_null($limit)) {
$query->limit($limit);
}

/**
* countNotifications
*
* Returns a number of notifications.
*
* ### Examples
* ```
* // if the user is logged in, this is the way to count all notifications
* $this->Notifier->countNotifications();
*
* // for a specific user, use the first parameter for the user_id
* $this->Notifier->countNotifications(1);
*
* // default all notifications are counted. Use the second parameter to define read / unread:
*
* // count all unread notifications
* $this->Notifier->countNotifications(1, true);
*
* // count all read notifications
* $this->Notifier->countNotifications(1, false);
* ```
* @param int|null $userId Id of the user.
* @param bool|null $state The state of notifications: `true` for unread, `false` for read, `null` for all.
* @return int
*/
public function countNotifications($userId = null, $state = null)
{
if (!$userId) {
$userId = $this->Controller->Auth->user('id');
}

$model = TableRegistry::get('Notifier.Notifications');

$query = $model->find()->where(['Notifications.user_id' => $userId]);

if (!is_null($state)) {
$query->where(['Notifications.state' => $state]);
}

return $query->count();
return $query->toArray();
}

/**
* countNotifications
*
* Returns a number of notifications.
*
* ### Examples
* ```
* // if the user is logged in, this is the way to count all notifications
* $this->Notifier->countNotifications();
*
* // for a specific user, use the first parameter for the user_id
* $this->Notifier->countNotifications(1);
*
* // default all notifications are counted. Use the second parameter to define read / unread:
*
* // count all unread notifications
* $this->Notifier->countNotifications(1, true);
*
* // count all read notifications
* $this->Notifier->countNotifications(1, false);
* ```
* @param int|null $userId Id of the user.
* @param bool|null $state The state of notifications: `true` for unread, `false` for read, `null` for all.
* @return int
*/
public function countNotifications($userId = null, $state = null) {
if (!$userId) {
$userId = $this->Controller->Auth->user('id');
}

/**
* markAsRead
*
* Used to mark a notification as read.
* If no notificationId is given, all notifications of the chosen user will be marked as read.
*
* @param int $notificationId Id of the notification.
* @param int|null $user Id of the user. Else the id of the session will be taken.
* @return void
*/
public function markAsRead($notificationId = null, $user = null)
{
if (!$user) {
$user = $this->Controller->Auth->user('id');
}

$model = TableRegistry::get('Notifier.Notifications');

if (!$notificationId) {
$query = $model->find('all')->where([
'user_id' => $user,
'state' => 1
]);
} else {
$query = $model->find('all')->where([
'user_id' => $user,
'id' => $notificationId

]);
}

foreach ($query as $item) {
$item->set('state', 0);
$model->save($item);
}
$model = TableRegistry::get('Notifier.Notifications');

$query = $model->find()->where(['Notifications.user_id' => $userId]);

if (!is_null($state)) {
$query->where(['Notifications.state' => $state]);
}

/**
* notify
*
* Sends notifications to specific users.
* The first parameter `$data` is an array with multiple options.
*
* ### Options
* - `users` - An array or int with id's of users who will receive a notification.
* - `roles` - An array or int with id's of roles which all users ill receive a notification.
* - `template` - The template wich will be used.
* - `vars` - The variables used in the template.
*
* ### Example
* ```
* NotificationManager::instance()->notify([
* 'users' => 1,
* 'template' => 'newOrder',
* 'vars' => [
* 'receiver' => $receiver->name
* 'total' => $order->total
* ],
* ]);
* ```
*
* @param array $data Data with options.
* @return string
*/
public function notify($data)
{
return NotificationManager::instance()->notify($data);
return $query->count();
}

/**
* markAsRead
*
* Used to mark a notification as read.
* If no notificationId is given, all notifications of the chosen user will be marked as read.
*
* @param int $notificationId Id of the notification.
* @param int|null $user Id of the user. Else the id of the session will be taken.
* @return void
*/
public function markAsRead($notificationId = null, $user = null) {
if (!$user) {
$user = $this->Controller->Auth->user('id');
}

$model = TableRegistry::get('Notifier.Notifications');

if (!$notificationId) {
$query = $model->find('all')->where([
'user_id' => $user,
'state' => 1
]);
} else {
$query = $model->find('all')->where([
'user_id' => $user,
'id' => $notificationId
]);
}

foreach ($query as $item) {
$item->set('state', 0);
$model->save($item);
}
}

/**
* notify
*
* Sends notifications to specific users.
* The first parameter `$data` is an array with multiple options.
*
* ### Options
* - `users` - An array or int with id's of users who will receive a notification.
* - `roles` - An array or int with id's of roles which all users ill receive a notification.
* - `template` - The template wich will be used.
* - `vars` - The variables used in the template.
*
* ### Example
* ```
* NotificationManager::instance()->notify([
* 'users' => 1,
* 'template' => 'newOrder',
* 'vars' => [
* 'receiver' => $receiver->name
* 'total' => $order->total
* ],
* ]);
* ```
*
* @param array $data Data with options.
* @return string
*/
public function notify($data) {
return NotificationManager::instance()->notify($data);
}

}

0 comments on commit 413dd9e

Please sign in to comment.