cakemanager/notifier

Notifications plugin for CakePHP 3.x

Justin Atack

@justinatack

I can't work out how you output the notification "message" title/body. The "notifications" var in the view just contains a JSON string and no template title/body. Is there a view function that outputs the vars and template as a string?

Justin Atack

@justinatack

Array
(
[0] => Notifier\Model\Entity\Notification Object
(
[id] => 3
[template] => newUser
[vars] => {"loggedin_user":"Justin DEDACTED","new_user":"Rex DEDACTED"}
[user_id] => 1
[state] => 1
[created] => Cake\I18n\Time Object
(
[time] => 2016-01-05T05:09:38+0000
[timezone] => UTC
[fixedNowTime] =>
)

        [modified] => Cake\I18n\Time Object
            (
                [time] => 2016-01-05T05:09:38+0000
                [timezone] => UTC
                [fixedNowTime] => 
            )

        [tracking_id] => YIjHeLBdam
        [[new]] => 
        [[accessible]] => Array
            (
                [template] => 1
                [vars] => 1
                [tracking_id] => 1
                [user_id] => 1
            )

        [[dirty]] => Array
            (
            )

        [[original]] => Array
            (
            )

        [[virtual]] => Array
            (
                [0] => title
                [1] => body
                [2] => unread
                [3] => read
            )

        [[errors]] => Array
            (
            )

        [[repository]] => Notifier.Notifications
    )

}

This is the notifications array output in my view. Where is the template title/body?

Bob Mulder

@bobmulder

Hi man. I am trying to get some sleep but a short reply: The entity you are getting back has the virtual fields title and body. As well you cam try to convert the entity to an array with toArray(). Get that?

Bob Mulder

@bobmulder

Let me know ;) I see you struggle a lot with this so we should think about improving the docs I guess...

Justin Atack

@justinatack

Sorry to disturb your sleep. My code can wait. I guess a code example of how to handle things in the view would be great. I'm not sure what you mean by toArray(). Better docs are always a good thing :) stops peple like me hassling you. If I get this worked out I'm more than happy to contribute back to your docs on GitHub from a noob perspective.

Bob Mulder

@bobmulder

@justinatack as you can see here (https://github.com/cakemanager/cakephp-notifier/blob/master/src/Model/Entity/Notification.php#L77-L121) the notification-entity contains the virual fields. So, to get the title you use $notification->title.

The notifier plugin works with templates, and I think I didn't explain that clear enough in the docs. Templates are NOT the same as templates in CakePHP itself. You can register templates inside your config/bootstrap.php for example:

$notificationManager->addTemplate('newBlog', [
    'title' => 'New blog by :username',
    'body' => ':username has posted a new blog named :name'
]);

(templates are stored in the Configure-class of Cake)

You can 'use' this template when you create a notification:

$notificationManager->notify([
    'users' => [1,2],
    'recipientLists' => ['administrators'],
    'template' => 'newBlog', // <--------------- HERE YOU GO
    'vars' => [
        'username' => 'Bob Mulder',
        'name' => 'My great new blogpost'
    ]
]);

Docs: https://github.com/cakemanager/cakephp-notifier#templates

I hope this made sense, else let me know ;)

iamsaloc

@cruamps

Hi.
Is there a way to use Notifier with localized templates (title / body) ?
Some recipients are English and others are French or German.

Bob Mulder

@bobmulder

Hi @cruamps, good question! The plugin does not provide because I've never needed it ;P

Maybe you can work on a PR? :)

iamsaloc

@cruamps

I'll think about it ;)

Bob Mulder

@bobmulder

Great ;) You could add a column to the table to keep the lanuages if needed...

AKKAWEB

@akkaweb

Hello! Kudos for a great plugin! I just started using it yesterday and I've got excited about it. :) . I have a question, which might be more CakePHP than your plugin, but I am hoping you will help me figure it out. I would like to detect a save that is performed by a Plugin and add a notification for it. The concrete example is a simple Feedback Plugin I created (https://github.com/akkaweb/AKKA-CakePHP-Feedback-Plugin) and I would like to detect when it saves the feedback without actually making a change to the plugin itself. Is that possible? If so, how can I accomplish it? Thanks !

Bob Mulder

@bobmulder

Hey @akkaweb, thanks for your kudos :)

I am afraid this can't be done without any changes. The good news is that the change can be very simple. Have you ever heard of cake's events?

AKKAWEB

@akkaweb

Hey @bobmulder , thanks for the reply. I am aware of Cake Events but have not used it yet to comfortably know what to do. What do you suggest?

Bob Mulder

@bobmulder

I will send you a code sample as soon as possible @akkaweb

Bob Mulder

@bobmulder

@akkaweb This is an example how to work with events to make your plugin work with the notifier.

First of all: read more about events here: http://book.cakephp.org/3.0/en/core-libraries/events.html

This example shows you what to do in your model. Lets call your event in your case 'Model.Feedback.afterSave'. This is the only change you should do at the side of your plugin. Whats done now, is that when a feedback item has been sent, the event is called.

So what we got to do now is use the event to notify.

For that we need a listener. If you see that example, it should be clear enough you have to catch your event, and use the Notifier...

AKKAWEB

@akkaweb

@bobmulder thank you for that. I will try and implement that within my plugin. I will post back with how successful I get with it. In true, I had read about events in the book several times, but I always left with some confusion. But I think now, I understand the separation between the event itself and listeners. Thanks for that!

AKKAWEB

@akkaweb

@bobmulder Because I wanted to attach notifications to other plugins that are not in my control and I could not change their code, I researched a little more and I found the following solution

Because CakePHP already has an afterSaveevent that is fired by the Model, all I had to do was create src/Event/FeedbackListener.php and look into the Fired Model Event for the Feedback Save Event

Bob Mulder

@bobmulder

Did you manage to do that @akkaweb? I doubt because the afterSave event has been fired only to that class, right?

AKKAWEB

@akkaweb

Here is the code that I used in my FeedbackListener.php

This message was deleted

Bob Mulder

@bobmulder

Haha please, use markdown :P

AKKAWEB

@akkaweb

Ok... let me try

Where communities thrive

People

Repo info

Activity