TaskHandler::processTasks() - Code Metrics - ggoffy/wgevents - Measure and Improve Code Quality continuously with Scrutinizer

TaskHandler::processTasks() D
last analyzed 2025-11-09 08:21 UTC

↳ Parent: TaskHandler
Complexity

Conditions	19
Paths	18
Size

Total Lines	104
Code Lines	72
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	19
eloc	72
c	1
b	0
f	1
nc	18
nop	1
dl	0
loc	104
rs	4.5166
How to fix Long Method Complexity

<?php

declare(strict_types=1);


namespace XoopsModules\Wgevents;

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

/**
 * wgEvents module for xoops
 *
 * @copyright    2021 XOOPS Project (https://xoops.org)
 * @license      GPL 2.0 or later
 * @package      wgevents
 * @since        1.0.0
 * @min_xoops    2.5.11 Beta1
 * @author       Goffy - Wedega - Email:[email protected] - Website:https://xoops.wedega.com
 */

use XoopsModules\Wgevents;
use XoopsModules\Wgevents\{
    Constants,
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
    MailHandler
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
};

/**
 * Class Object Handler Task
 */
class TaskHandler extends \XoopsPersistableObjectHandler
{
    /**
     * Constructor
     *
     * @param \XoopsDatabase $db
     */
    public function __construct(\XoopsDatabase $db)
    {
        parent::__construct($db, 'wgevents_task', Task::class, 'id', 'id');
    }

    /**
     * @param bool $isNew
     *
     * @return object
     */
    public function create($isNew = true)
    {
        return parent::create($isNew);
    }

    /**
     * retrieve a field
     *
     * @param int $id field id
     * @param $fields
     * @return \XoopsObject|null reference to the {@link Get} object
     */
    public function get($id = null, $fields = null)
    {
        return parent::get($id, $fields);
    }

    /**
     * get inserted id
     *
     * @return int reference to the {@link Get} object
     */
    public function getInsertId()
    {
        return $this->db->getInsertId();
    }

    /**
     * Get Count Task in the database
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @return int
     */
    public function getCountTasks($start = 0, $limit = 0, $sort = 'id', $order = 'ASC')
    {
        $crCountTasks = new \CriteriaCompo();
        $crCountTasks = $this->getTasksCriteria($crCountTasks, $start, $limit, $sort, $order);
        return $this->getCount($crCountTasks);
        return $this->getCount(/** @scrutinizer ignore-type */ $crCountTasks);
    }

    /**
     * Get All Task in the database
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @return array
     */
    public function getAllTasks($start = 0, $limit = 0, $sort = 'id', $order = 'DESC')
    {
        $crAllTasks = new \CriteriaCompo();
        $crAllTasks = $this->getTasksCriteria($crAllTasks, $start, $limit, $sort, $order);
        return $this->getAll($crAllTasks);
        return $this->getAll(/** @scrutinizer ignore-type */ $crAllTasks);
    }

    /**
     * Get Criteria Task
     * @param        $crTasks
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @return int
     */
    private function getTasksCriteria($crTasks, $start, $limit, $sort, $order)
    {
        $crTasks->setStart($start);
        $crTasks->setLimit($limit);
        $crTasks->setSort($sort);
        $crTasks->setOrder($order);
        return $crTasks;
    }

    /**
     * Get count open tasks for cron.php
     * @return int
     */
    public function getCountTasksOpen()
    {
        $crTask = new \CriteriaCompo();
        $crTask->add(new \Criteria('status', Constants::STATUS_DONE, '<'));

        return $this->getCount($crTask);
    }

    /**
     * Create a task
     * @param $type
     * @param $recipient
     * @param $params
     * @return bool
     */
    public function createTask($type, $recipient, $params)
    {
        $uidCurrent = \is_object($GLOBALS['xoopsUser']) ? (int)$GLOBALS['xoopsUser']->uid() : 0;

        $taskObj = $this->create();
        // Set Vars
        $taskObj->setVar('type', $type);
        $taskObj->setVar('params', $params);
        $taskObj->setVar('recipient', $recipient);
        $taskObj->setVar('datecreated', time());
        $taskObj->setVar('submitter', $uidCurrent);
        $taskObj->setVar('status', Constants::STATUS_PENDING);

        // Insert Data
        return (bool)$this->insert($taskObj);
    }

    /**
     * process all task if limit is not exceeded
     * @param $log_level
     * @return array
     */
    public function processTasks($log_level = 0)
    {
        $helper = \XoopsModules\Wgevents\Helper::getInstance();

        // get limit_hour from primary account
        $accountHandler = $helper->getHandler('Account');
        $limitHour = $accountHandler->getLimitHour();

        $resProcess = '';

        $crTaskPending = new \CriteriaCompo();
        $crTaskPending->add(new \Criteria('status', Constants::STATUS_PENDING));
        $tasksCountPending = $this->getCount($crTaskPending);
        $crTaskPending->setSort('type ASC, id');
        $crTaskPending->setOrder('ASC');

        // if all works properly there shouldn't be a task type 'processing' left
        $crTaskProcessing = new \CriteriaCompo();
        $crTaskProcessing->add(new \Criteria('status', Constants::STATUS_PROCESSING));
        $tasksCountProcessing = $this->getCount($crTaskProcessing);

        $crTaskDone = new \CriteriaCompo();
        $crTaskDone->add(new \Criteria('status', Constants::STATUS_DONE));
        $crTaskDone->add(new \Criteria('datedone', time() - 3600, '>'));
        $tasksCountDone = $this->getCount($crTaskDone);

        $counterDone = 0;
        if ($log_level > 0) {
            $resProcess .=  '<br>Start processTasks';
            $resProcess .=  '<br>time - 3600: ' . \formatTimestamp(time() - 3600, 'm');
            if ($tasksCountProcessing > 0) {
                $resProcess .= '<br><span style="color:#ff0000;font-weight:700">Count status PROCESSING at start: ' . $tasksCountProcessing . '</span>';
            }
            $resProcess .=  '<br>Count status PENDING at start: ' . $tasksCountPending;
            $resProcess .=  '<br>Count status DONE at start: ' . $tasksCountDone;
        }
        if (($tasksCountPending > 0) && ($tasksCountDone < $limitHour || 0 === $limitHour)) {
            if ($limitHour > 0) {
                $crTaskPending->setLimit($limitHour);
            }
            $tasksAll = $this->getAll($crTaskPending);
            $resultMH = 0;
            foreach (\array_keys($tasksAll) as $i) {
                // check whether task is still pending
                // ignore it if meanwhile another one started to process the task
                if ($log_level > 1) {
                    $resProcess .=  '<br>Task key: ' . $i;
                }
                if (554 === $resultMH) {
                    $resProcess .=  '<br>Skipped Error 554: SMTP limit exceeded';
                } elseif ((Constants::STATUS_PENDING == (int)$tasksAll[$i]->getVar('status'))
                    && ($tasksCountDone < $limitHour || 0 == $limitHour)) {
                    $taskProcessObj = $this->get($i);
                    $taskProcessObj->setVar('status', Constants::STATUS_PROCESSING);
                    if ($this->insert($taskProcessObj)) {
                    if ($this->insert(/** @scrutinizer ignore-type */ $taskProcessObj)) {
                        $mailsHandler = new MailHandler();
                        $mailParams = json_decode($tasksAll[$i]->getVar('params', 'n'), true);
                        $mailParams['recipients'] = $tasksAll[$i]->getVar('recipient');
                        $mailParams['taskId'] = $i;
                        $mailsHandler->setParams($mailParams);
                        $mailsHandler->setType($tasksAll[$i]->getVar('type'));
                        // send mails
                        $resultMH = $mailsHandler->execute();
                        unset($mailsHandler);
                        //update task list corresponding the result
                        if (0 === $resultMH) {
                            $taskProcessObj->setVar('status', Constants::STATUS_DONE);
                            $taskProcessObj->setVar('datedone', time());
                            $counterDone++;
                            if ($log_level > 1) {
                                $resProcess .=  ' - done';
                            }
                        } else {
                            $taskProcessObj->setVar('status', Constants::STATUS_PENDING);
                            if ($log_level > 1) {
                                $resProcess .=  ' - failed';
                            }
                        }
                        $this->insert($taskProcessObj);
                    } else {
                        $resProcess .=  ' - error insert taskProcessObj';
                    }
                }
                unset($taskProcessObj);
                $taskProcessObj = $this->get($i);
                //check whether process is still pending, what should not be
                if (Constants::STATUS_PROCESSING === (int)$taskProcessObj->getVar('status')) {
                    $taskProcessObj->setVar('status', Constants::STATUS_PENDING);
                    $this->insert($taskProcessObj);
                }
                // check once more number of done
                $tasksCountDone = $this->getCount($crTaskDone);
            }
        }
        // check once more number of open tasks
        $crTaskOpen = new \CriteriaCompo();
        $crTaskOpen->add(new \Criteria('status', Constants::STATUS_DONE, '<'));
        $tasksCountOpen = $this->getCount($crTaskOpen);

        if ($log_level > 0) {
            $resProcess .=  '<br>End processTasks';
        }

        return ['pending' => $tasksCountPending, 'done' => $counterDone, 'resprocess' => $resProcess, 'still_open' => $tasksCountOpen];
    }
}

ggoffy / wgevents

TaskHandler::processTasks() D last analyzed 2025-11-09 08:21 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

TaskHandler::processTasks() D
last analyzed 2025-11-09 08:21 UTC
