AlumniNotificationsPlugin

Complexity

Total Complexity

7

Size/Duplication

Total Lines	119
Duplicated Lines	17.65 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	item()	21	40	4
B	categories()	0	25	1
B	events()	0	25	1
A	tags()	0	4	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 27 and the first side effect is on line 21.

/*
 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

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @param string $category
     * @param int    $item_id
     *
     * @return array
     */
    public function item($category, $item_id)

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        $xoops   = Xoops::getInstance();

$xoops is not used, you could remove the assignment.

        $item    = [];
        $item_id = (int)$item_id;

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

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

            return $item;
        }

        global $xoopsDB;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

This code seems to be duplicated across your project.

            // Assume we have a valid topid id
            $sql          = 'SELECT title  FROM ' . $xoopsDB->prefix('alumni_categories') . ' WHERE cid = ' . $item_id . ' LIMIT 1';

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $result       = $xoopsDB->query($sql); // TODO: error check
            $result_array = $xoopsDB->fetchArray($result);

$result_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $item['name'] = $result_array['title'];

$result_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/categories.php?cid=' . $item_id;

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The variable $module does not exist. Did you forget to declare it?

            return $item;
        }

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

This code seems to be duplicated across your project.

            // Assume we have a valid post id
            $sql          = 'SELECT title FROM ' . $xoopsDB->prefix('alumni_listing') . ' WHERE lid = ' . $item_id . ' LIMIT 1';

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $result       = $xoopsDB->query($sql);
            $result_array = $xoopsDB->fetchArray($result);

$result_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $item['name'] = $result_array['title'];

$result_array does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/listing.php?lid= ' . $item_id;

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            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)

$item_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        return [];
    }
}