xoops forums

goffy

Just can't stay away
Posted on: 3/28 7:08
goffy
goffy (Show more)
Just can't stay away
Posts: 409
Since: 2010/12/27
#1

How to implement a notification for comments

You want to get a notification if someone makes a comment?

In this example you can see the implementation in module wgGallery

1) Adapt xoops_version.php
First step:
you have to check whether there is a callback function defined or not
// Comment callback functions
$modversion['comments']['callbackFile']        = 'include/comment_functions.php';
$modversion['comments']['callback']['approve'] = 'wggalleryCommentsApprove';
$modversion['comments']['callback']['update']  = 'wggalleryCommentsUpdate';


if not please as the definition to xoops_version.php

Second step:
You have to add the notification options, which you want to have. In wgGallery we have the option to get a notification of a comment
a) in any case
// Global Events Image commented
$modversion['notification']['event'][] = [
            
'name'          => 'img_comment_all',
            
'category'      => 'global',
            
'admin_only'    => 0,
            
'title'         => _MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY,
            
'caption'       => _MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY_CAPTION,
            
'description'   => '',
            
'mail_template' => 'global_img_comment_notify',
            
'mail_subject'  => _MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY_SUBJECT,
        ];


b) or if an image of a specific album have been commented
// Album Events Image commented
$modversion['notification']['event'][] = [
            
'name'          => 'image_comment',
            
'category'      => 'albums',
            
'admin_only'    => 0,
            
'title'         => _MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY,
            
'caption'       => _MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY_CAPTION,
            
'description'   => '',
            
'mail_template' => 'global_img_comment_notify',
            
'mail_subject'  => _MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY_SUBJECT,
        ];



2) Language files
add the defines to your language file modinfo.php
define('_MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY''Notify me about new comments for images');
define('_MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY_CAPTION''Notify me about comments for images');
define('_MI_WGGALLERY_GLOBAL_IMG_COMMENT_NOTIFY_SUBJECT''Notification about comments for an image');
define('_MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY''Notify me about new comments for images in this album');
define('_MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY_CAPTION''Notify me about comments for images in this album');
define('_MI_WGGALLERY_ALBUMS_IMG_COMMENT_NOTIFY_SUBJECT''Notification about new comment for an image');



3) Adapt include/comment_functions.php
In any case a comment is sent and approved xoops with call the callback function wggalleryCommentsApprove($comment)
As a parameter you get the comment object with all necessary information
Therefore we need only to add the call of notification handler
$helper XoopsModulesWggalleryHelper::getInstance();
// send notifications
$imgId               $comment->getVar('com_itemid');
$imageObj            $helper->getHandler('Images')->get($imgId);
$albId               $imageObj->getVar('img_albid');
$tags                = [];
$tags['IMAGE_NAME']  = $imageObj->getVar('img_name');
$tags['IMAGE_URL']   = XOOPS_URL '/modules/' $GLOBALS['xoopsModule']->getVar('dirname') . '/images.php?op=show&img_id=' $imgId '&alb_id=' $albId;
$tags['ALBUM_URL']   = XOOPS_URL '/modules/' $GLOBALS['xoopsModule']->getVar('dirname') . '/albums.php?op=show&alb_id=' $albId;
$notificationHandler xoops_getHandler('notification');
$notificationHandler->triggerEvent('global'0'img_comment_all'$tags, [], $comment->getVar('com_modid'));
$notificationHandler->triggerEvent('albums'$albId'img_comment'$tags);


4) Add notification template to language file

Add a notification template to language/english/mail_template (or in your language file directory).
Use the name you defined in xoops_version.php, in our example:
'mail_template' => 'global_img_comment_notify'


Thats all :)

Mamba

Moderator
Posted on: 3/28 13:04
Mamba
Mamba (Show more)
Moderator
Posts: 10933
Since: 2004/4/23
#2

Re: How to implement a notification for comments

Thanks for sharing!!!!

This is definitely a very good tutorial on how to make it happen!
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

zyspec

Module Developer
Posted on: 3/28 15:15
zyspec
zyspec (Show more)
Module Developer
Posts: 1075
Since: 2004/9/21
#3

Re: How to implement a notification for comments

Thanks @goffy!

It's always great to have examples how to implement a feature.