NewbbDigestHandler::delete() - Code Metrics - Inspection of "Issues with digest" - mambax7/newbb5 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Richard

created 2017-09-12 03:04 UTC

NewbbDigestHandler::delete() A

↳ Parent: NewbbDigestHandler

Complexity

Conditions	3
Paths	4

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	4
nop	2
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * NewBB 5.0x,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <[email protected]>
 * @since          4.00
 * @package        module::newbb
 */
class Digest extends XoopsObject
namespace YourVendor;

class YourClass { }
{
    public $digest_id;
    public $digest_time;
    public $digest_content;

    public $items;
    public $isHtml    = false;
    public $isSummary = true;

    /**
     *
     */
    public function __construct()

    {
        parent::__construct();
        $this->initVar('digest_id', XOBJ_DTYPE_INT);
        $this->initVar('digest_time', XOBJ_DTYPE_INT);
        $this->initVar('digest_content', XOBJ_DTYPE_TXTAREA);
        $this->items = [];
    }

    public function setHtml()
    {
        $this->isHtml = true;
    }

    public function setSummary()
    {
        $this->isSummary = true;
    }

    /**
     * @param        $title
     * @param        $link
     * @param        $author
     * @param string $summary
     */
    public function addItem($title, $link, $author, $summary = '')
    {
        $title  = $this->cleanup($title);
        $author = $this->cleanup($author);
        if (!empty($summary)) {
            $summary = $this->cleanup($summary);
        }
        $this->items[] = ['title' => $title, 'link' => $link, 'author' => $author, 'summary' => $summary];
    }

    /**
     * @param $text
     * @return mixed|string
     */
    public function cleanup($text)
    {
        global $myts;
function myFunction($a, $b) {
    // Do something
}

        $clean = stripslashes($text);
        $clean =& $myts->displayTarea($clean, 1, 0, 1);
        $clean = strip_tags($clean);
        $clean = htmlspecialchars($clean, ENT_QUOTES);

        return $clean;
    }

    /**
     * @param  bool $isSummary
     * @param  bool $isHtml
     * @return bool
     */
    public function buildContent($isSummary = true, $isHtml = false)
    {
        $digest_count = count($this->items);
        $content      = '';
        if ($digest_count > 0) {
            $linebreak = $isHtml ? '<br>' : "\n";
            for ($i = 0; $i < $digest_count; ++$i) {
                if ($isHtml) {
                    $content .= ($i + 1) . '. <a href=' . $this->items[$i]['link'] . '>' . $this->items[$i]['title'] . '</a>';
                } else {
                    $content .= ($i + 1) . '. ' . $this->items[$i]['title'] . $linebreak . $this->items[$i]['link'];
                }

                $content .= $linebreak . $this->items[$i]['author'];
                if ($isSummary) {
                    $content .= $linebreak . $this->items[$i]['summary'];
                }
                $content .= $linebreak . $linebreak;
            }
        }
        $this->setVar('digest_content', $content);

        return true;
    }
}

/**
 * Class NewbbDigestHandler
 */
class NewbbDigestHandler extends XoopsPersistableObjectHandler
namespace YourVendor;

class YourClass { }
{
    public $last_digest;

    /**
     * Constructor
     *
     * @param null|XoopsDatabase $db             database connection
     */
    function __construct(XoopsDatabase $db)

    {
        parent::__construct($db, 'newbb_digest', 'Digest', 'digest_id');
    }

    /**
     * @param  bool $isForced
     * @return int
     */
    public function process($isForced = false)
    {
        $this->getLastDigest();
        if (!$isForced) {
            $status = $this->checkStatus();
            if ($status < 1) {
                return 1;
            }
        }
        $digest = $this->create();
        $status = $this->buildDigest($digest);
        if (!$status) {
            return 2;
        }
        $status = $this->insert($digest);
        if (!$status) {
            return 3;
        }
        $status = $this->notify($digest);
        if (!$status) {
            return 4;
        }

        return 0;
    }

    /**
     * @param  XoopsObject $digest
     * @return bool
     */
    public function notify(XoopsObject $digest)
    {
        //$content                = $digest->getVar('digest_content');

        /** @var \XoopsNotificationHandler $notificationHandler */
        $notificationHandler    = xoops_getHandler('notification');
        $tags['DIGEST_ID']      = $digest->getVar('digest_id');
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $tags['DIGEST_CONTENT'] = $digest->getVar('digest_content', 'E');
        $notificationHandler->triggerEvent('global', 0, 'digest', $tags);

        return true;
    }

    /**
     * @param        $start
     * @param  int   $perpage
     * @return array
     */
    public function getAllDigests($start = 0, $perpage = 5)
    {
        //        if (empty($start)) {

        //            $start = 0;

        //        }

        $sql    = 'SELECT * FROM ' . $this->db->prefix('newbb_digest') . ' ORDER BY digest_id DESC';
        $result = $this->db->query($sql, $perpage, $start);
        $ret    = [];
        //        $reportHandler = xoops_getModuleHandler('report', 'newbb');

        while ($myrow = $this->db->fetchArray($result)) {
            $ret[] = $myrow; // return as array

        }

        return $ret;
    }

    /**
     * @return int
     */
    public function getDigestCount()
    {
        $sql    = 'SELECT COUNT(*) AS count FROM ' . $this->db->prefix('newbb_digest');
        $result = $this->db->query($sql);
        if (!$result) {
            return 0;
        } else {
            $array = $this->db->fetchArray($result);

            return $array['count'];
        }
    }

    public function getLastDigest()
    {
        $sql    = 'SELECT MAX(digest_time) AS last_digest FROM ' . $this->db->prefix('newbb_digest');
        $result = $this->db->query($sql);
        if (!$result) {
            $this->last_digest = 0;
            // echo "<br>no data:".$query;

        } else {
            $array             = $this->db->fetchArray($result);
            $this->last_digest = isset($array['last_digest']) ? $array['last_digest'] : 0;
        }
    }

    /**
     * @return int

     */
    public function checkStatus()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!isset($this->last_digest)) {
            $this->getLastDigest();
        }
        $deadline  = (1 == $GLOBALS['xoopsModuleConfig']['email_digest']) ? 60 * 60 * 24 : 60 * 60 * 24 * 7;
        $time_diff = time() - $this->last_digest;

        return $time_diff - $deadline;
    }

    /**
     * @param  XoopsObject $digest
     * @param  bool        $force  flag to force the query execution despite security settings
     * @return mixed       object ID or false
     */
    public function insert(XoopsObject $digest, $force = true)
    {
        return parent::insert($digest, $force);
        /*

        $content = $digest->getVar('digest_content', 'E');

        $id  = $this->db->genId($digest->table . '_digest_id_seq');
        $sql = 'INSERT INTO ' . $digest->table . ' (digest_id, digest_time, digest_content)    VALUES (' . $id . ', ' . time() . ', ' . $this->db->quoteString($content) . ' )';

        if (!$this->db->queryF($sql)) {
            //echo "<br>digest insert error::" . $sql;
            return false;
        }
        if (empty($id)) {
            $id = $this->db->getInsertId();
        }
        $digest->setVar('digest_id', $id);

        return true;
        */
    }

    /**
     * @param  XoopsObject $digest
     * @param  bool        $force (ignored)
     * @return bool        FALSE if failed.
     */
    public function delete(XoopsObject $digest, $force = false)
    {
        $digest_id = $digest->getVar('digest_id');

        if (!isset($this->last_digest)) {
            $this->getLastDigest();
        }
        if ($this->last_digest == $digest_id) {
            return false;
        } // It is not allowed to delete the last digest

        return parent::delete($digest, true);
    }

    /**
     * @param  XoopsObject|\Digest $digest
     * @return bool
     */
    public function buildDigest(XoopsObject $digest)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}

        if (!defined('SUMMARY_LENGTH')) {
            define('SUMMARY_LENGTH', 100);
        }

        /** @var \NewbbForumHandler $forumHandler */
        $forumHandler         = xoops_getModuleHandler('forum', 'newbb');
        $thisUser             = $GLOBALS['xoopsUser'];
        $GLOBALS['xoopsUser'] = null; // To get posts accessible by anonymous
        $GLOBALS['xoopsUser'] = $thisUser;

        $accessForums    = $forumHandler->getIdsByPermission(); // get all accessible forums
        $forumCriteria   = ' AND t.forum_id IN (' . implode(',', $accessForums) . ')';
        $approveCriteria = ' AND t.approved = 1 AND p.approved = 1';
        $time_criteria   = ' AND t.digest_time > ' . $this->last_digest;

        $karma_criteria = $GLOBALS['xoopsModuleConfig']['enable_karma'] ? ' AND p.post_karma=0' : '';
        $reply_criteria = $GLOBALS['xoopsModuleConfig']['allow_require_reply'] ? ' AND p.require_reply=0' : '';

        $query = 'SELECT t.topic_id, t.forum_id, t.topic_title, t.topic_time, t.digest_time, p.uid, p.poster_name, pt.post_text FROM '
                 . $this->db->prefix('newbb_topics')
                 . ' t, '
                 . $this->db->prefix('newbb_posts_text')
                 . ' pt, '
                 . $this->db->prefix('newbb_posts')
                 . ' p WHERE t.topic_digest = 1 AND p.topic_id=t.topic_id AND p.pid=0 '
                 . $forumCriteria
                 . $approveCriteria
                 . $time_criteria
                 . $karma_criteria
                 . $reply_criteria
                 . ' AND pt.post_id=p.post_id ORDER BY t.digest_time DESC';
        if (!$result = $this->db->query($query)) {
            //echo "<br>No result:<br>$query";
            return false;
        }
        $rows  = [];
        $users = [];
        while ($row = $this->db->fetchArray($result)) {
            $users[$row['uid']] = 1;
            $rows[]             = $row;
        }
        if (count($rows) < 1) {
            return false;
        }
        $uids = array_keys($users);
        if (count($uids) > 0) {
            /** @var \XoopsMemberHandler $memberHandler */
            $memberHandler = xoops_getHandler('member');
            $user_criteria = new Criteria('uid', '(' . implode(',', $uids) . ')', 'IN');
            $users         = $memberHandler->getUsers($user_criteria, true);
        } else {
            $users = [];
        }

        foreach ($rows as $topic) {
            if ($topic['uid'] > 0) {
                if (isset($users[$topic['uid']]) && is_object($users[$topic['uid']])
                    && $users[$topic['uid']]->isActive()) {
                    $topic['uname'] = $users[$topic['uid']]->getVar('uname');
                } else {
                    $topic['uname'] = $GLOBALS['xoopsConfig']['anonymous'];
                }
            } else {
                $topic['uname'] = $topic['poster_name'] ?: $GLOBALS['xoopsConfig']['anonymous'];
            }
            $summary = \Xmf\Metagen::generateDescription($topic['post_text'], SUMMARY_LENGTH);
            $author  = $topic['uname'] . ' (' . formatTimestamp($topic['topic_time']) . ')';
            $link    = XOOPS_URL . '/modules/' . $xoopsModule->dirname() . '/viewtopic.php?topic_id=' . $topic['topic_id'] . '&amp;forum=' . $topic['forum_id'];
            $title   = $topic['topic_title'];
            $digest->addItem($title, $link, $author, $summary);
        }
        $digest->buildContent();

        return true;
    }
}


Pull Request — master (#15)

NewbbDigestHandler::delete() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
2
3		/**
4		* NewBB 5.0x, the forum module for XOOPS project
5		*
6		* @copyright XOOPS Project (https://xoops.org)
7		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
8		* @author Taiwen Jiang (phppp or D.J.) <[email protected]>
9		* @since 4.00
10		* @package module::newbb
11		*/
12		class Digest extends XoopsObject
		0 ignored issues – show Coding Style Compatibility introduced 2017-06-25 02:50 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
13		{
14		public $digest_id;
15		public $digest_time;
16		public $digest_content;
17
18		public $items;
19		public $isHtml = false;
20		public $isSummary = true;
21
22		/**
23		*
24		*/
25	View Code Duplication	public function __construct()
		0 ignored issues – show Duplication introduced 2017-09-05 10:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
26		{
27		parent::__construct();
28		$this->initVar('digest_id', XOBJ_DTYPE_INT);
29		$this->initVar('digest_time', XOBJ_DTYPE_INT);
30		$this->initVar('digest_content', XOBJ_DTYPE_TXTAREA);
31		$this->items = [];
32		}
33
34		public function setHtml()
35		{
36		$this->isHtml = true;
37		}
38

mambax7 / newbb5

Pull Request — master (#15)

NewbbDigestHandler::delete() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like