mambax7/alumni-26x

View on GitHub
class/plugin/notifications.php

Summary

Maintainability
B
4 hrs
Test Coverage
<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/**
 * Alumni module for Xoops
 *
 * @copyright       XOOPS Project https://xoops.org/
 * @license         GPL 2.0 or later
 * @package         alumni
 * @since           2.6.x
 * @author          John Mordo (jlm69)
 */

defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
$moduleDirName = basename(dirname(dirname(__DIR__)));

/**
 * Class AlumniNotificationsPlugin
 */
class AlumniNotificationsPlugin extends Xoops\Module\Plugin\PluginAbstract implements NotificationsPluginInterface
{
    /**
     * @param string $category
     * @param int    $item_id
     *
     * @return array
     */
    public function item($category, $item_id)
    {
        $xoops   = Xoops::getInstance();
        $item    = [];
        $item_id = (int)$item_id;

        if ('global' === $category) {
            $item['name'] = '';
            $item['url']  = '';

            return $item;
        }

        global $xoopsDB;

        if ('category' === $category) {

            // Assume we have a valid topid id
            $sql          = 'SELECT title  FROM ' . $xoopsDB->prefix('alumni_categories') . ' WHERE cid = ' . $item_id . ' LIMIT 1';
            $result       = $xoopsDB->query($sql); // TODO: error check
            $result_array = $xoopsDB->fetchArray($result);
            $item['name'] = $result_array['title'];
            $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/categories.php?cid=' . $item_id;

            return $item;
        }

        if ('listing' === $category) {
            // Assume we have a valid post id
            $sql          = 'SELECT title FROM ' . $xoopsDB->prefix('alumni_listing') . ' WHERE lid = ' . $item_id . ' LIMIT 1';
            $result       = $xoopsDB->query($sql);
            $result_array = $xoopsDB->fetchArray($result);
            $item['name'] = $result_array['title'];
            $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/listing.php?lid= ' . $item_id;

            return $item;
        }

        return $item;
    }

    /**
     * @return array
     */
    public function categories()
    {
        Xoops::getInstance()->loadLocale('alumni');
        $ret                      = [];
        $ret[1]['name']           = 'global';
        $ret[1]['title']          = AlumniLocale::NOTIFICATION_GLOBAL;
        $ret[1]['description']    = AlumniLocale::NOTIFICATION_GLOBAL_DSC;
        $ret[1]['subscribe_from'] = ['index.php', 'categories.php'];

        $ret[2]['name']           = 'category';
        $ret[2]['title']          = AlumniLocale::NOTIFICATION_CATEGORY;
        $ret[2]['description']    = AlumniLocale::NOTIFICATION_CATEGORY_DSC;
        $ret[2]['subscribe_from'] = ['categories.php'];
        $ret[2]['item_name']      = 'cid';
        $ret[2]['allow_bookmark'] = 1;

        $ret[3]['name']           = 'alumni_listing';
        $ret[3]['title']          = AlumniLocale::NOTIFICATION_ITEM;
        $ret[3]['description']    = AlumniLocale::NOTIFICATION_ITEM_DSC;
        $ret[3]['subscribe_from'] = ['listing.php'];
        $ret[3]['item_name']      = 'lid';
        $ret[3]['allow_bookmark'] = 1;

        return $ret;
    }

    /**
     * @return array
     */
    public function events()
    {
        $ret = [];

        //event
        //alumni notifications new listings in this category
        $ret[1]['name']          = 'new_listing';
        $ret[1]['category']      = 'category';
        $ret[1]['title']         = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING;
        $ret[1]['caption']       = AlumniLocale::NOTIFICATION_CATEGORY_NEWLISTING_CAP;
        $ret[1]['description']   = AlumniLocale::NOTIFICATION_CATEGORY_NEWLISTING_DSC;
        $ret[1]['mail_template'] = 'listing_newpost_notify';
        $ret[1]['mail_subject']  = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING_SBJ;

        //new listings in all categories posted
        $ret[2]['name']          = 'new_listing';
        $ret[2]['category']      = 'global';
        $ret[2]['title']         = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING;
        $ret[2]['caption']       = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING_CAP;
        $ret[2]['description']   = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING_DSC;
        $ret[2]['mail_template'] = 'listing_newpost_notify';
        $ret[2]['mail_subject']  = AlumniLocale::NOTIFICATION_GLOBAL_NEWLISTING_SBJ;

        return $ret;
    }

    /**
     * @param string $category
     * @param int    $item_id
     * @param string $event
     *
     * @return array
     */
    public function tags($category, $item_id, $event)
    {
        return [];
    }
}