XoopsModules\Wgevents\RegistrationHandler

Complexity

Total Complexity

33

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	create()	0	3	1
A	get()	0	3	1
A	getAllRegistrations()	0	5	1
A	getInsertId()	0	3	1
A	getRegistrationsCriteria()	0	7	1
A	getCountRegistrations()	0	5	1
B	getRegistrationDetailsByEvent()	0	60	9
B	cleanupRegistrations()	0	54	8
B	getRegistrationsCompare()	0	49	9

<?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:webmaster@wedega.com - Website:https://xoops.wedega.com
 */

use XoopsModules\Wgevents;
use XoopsModules\Wgevents\{
    Helper,

This use statement conflicts with another class in this namespace, XoopsModules\Wgevents\Helper. Consider defining an alias.

    Utility

This use statement conflicts with another class in this namespace, XoopsModules\Wgevents\Utility. Consider defining an alias.

};

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

    /**
     * @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 Registration in the database
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @return int
     */
    public function getCountRegistrations($start = 0, $limit = 0, $sort = 'id', $order = 'DESC')
    {
        $crCountRegistrations = new \CriteriaCompo();
        $crCountRegistrations = $this->getRegistrationsCriteria($crCountRegistrations, $start, $limit, $sort, $order);
        return $this->getCount($crCountRegistrations);
    }

    /**
     * Get All Registration in the database
     * @param int    $start
     * @param int    $limit
     * @param string $sort
     * @param string $order
     * @return array
     */
    public function getAllRegistrations($start = 0, $limit = 0, $sort = 'id', $order = 'DESC')
    {
        $crAllRegistrations = new \CriteriaCompo();
        $crAllRegistrations = $this->getRegistrationsCriteria($crAllRegistrations, $start, $limit, $sort, $order);
        return $this->getAll($crAllRegistrations);
    }

    /**
     * Get Criteria Registration
     * @param        $crRegistration
     * @param int $start
     * @param int $limit
     * @param string $sort
     * @param string $order
     * @return \CriteriaCompo
     */
    private function getRegistrationsCriteria($crRegistration, int $start, int $limit, string $sort, string $order)
    {
        $crRegistration->setStart($start);
        $crRegistration->setLimit($limit);
        $crRegistration->setSort($sort);
        $crRegistration->setOrder($order);
        return $crRegistration;
    }

    /**
     * Delete all registrations for given event
     * @param int $evId
     * @return bool
     */
    public function cleanupRegistrations(int $evId)
    {
        if ($evId > 0) {
            $helper = Helper::getInstance();
            $eventHandler = $helper->getHandler('Event');
            $taskHandler = $helper->getHandler('Task');

            $crRegistration = new \CriteriaCompo();
            $crRegistration->add(new \Criteria('evid', $evId));
            $registrationsCount = $this->getCount($crRegistration);
            if ($registrationsCount > 0) {
                // declare types
                $typeNotify = Constants::MAIL_REG_NOTIFY_CANCEL;
                $typeConfirm = Constants::MAIL_REG_CONFIRM_CANCEL;
                // get mail addresses from register_notify
                $eventObj = $eventHandler->get($evId);
                $registerNotify = (string)$eventObj->getVar('register_notify', 'e');
                //get all registrations
                $registrationsAll = $this->getAll($crRegistration);
                foreach (\array_keys($registrationsAll) as $i) {
                    $mailsHandler = new MailHandler();
                    $mailParams = $mailsHandler->getMailParam($eventObj, $i);
                    unset($mailsHandler);
                    if ($this->delete($registrationsAll[$i])) {
                        // Event delete notification
                        /*
                        $tags = [];
                        $tags['ITEM_NAME'] = $regEvid;
                        $notificationHandler = \xoops_getHandler('notification');
                        $notificationHandler->triggerEvent('global', 0, 'global_delete', $tags);
                        $notificationHandler->triggerEvent('registrations', $regId, 'registration_delete', $tags);
                        */
                        // send notifications/confirmation emails
                        if ('' !== $registerNotify) {
                            // send notifications to emails of register_notify
                            $notifyEmails = \preg_split("/\r\n|\n|\r/", $registerNotify);
                            foreach ($notifyEmails as $recipient) {
                                $taskHandler->createTask($typeNotify, $recipient, json_encode($mailParams));
                            }
                        }
                        $regEmail = $registrationsAll[$i]->getVar('email');
                        if ('' !== $regEmail) {
                            // send confirmation, if radio is checked
                            $taskHandler->createTask($typeConfirm, $regEmail, json_encode($mailParams));
                        }
                        // execute mail sending by task handler
                        $taskHandler->processTasks();
                    } else {
                        $GLOBALS['xoopsTpl']->assign('error', $registrationsAll[$i]->getHtmlErrors());
                    }
                }
            }
        }
        return true;
    }

    /**
     * get all registrations/answers of given event
     * @param int $evId // id of event
     * @param array $questionsArr // array with all questions for this event
     * @param bool $currentUserOnly // true: filter result for current user - false: return all for given event
     * @param string $sortBy // sort registrations by
     * @param string $orderBy // order for sorting
     * @return bool|array
     */
    public function getRegistrationDetailsByEvent(int $evId, array $questionsArr, $currentUserOnly = true, $sortBy = 'datecreated', $orderBy = 'ASC')
    {
        if ($evId > 0) {
            $helper  = \XoopsModules\Wgevents\Helper::getInstance();
            $eventHandler     = $helper->getHandler('Event');
            $answerHandler     = $helper->getHandler('Answer');
            $permissionsHandler = $helper->getHandler('Permission');

            $eventObj = $eventHandler->get($evId);
            $evSubmitter = $eventObj->getVar('submitter');
            $evStatus = $eventObj->getVar('status');

            $registrations = [];
            $crRegistration = new \CriteriaCompo();
            $crRegistration->add(new \Criteria('evid', $evId));
            if ($currentUserOnly) {
                $uidCurrent = \is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->uid() : 0;
                if ($uidCurrent > 0) {
                    $crRegistration->add(new \Criteria('submitter', $uidCurrent));
                } else {
                    $regIp = $_SERVER['REMOTE_ADDR'];
                    $crRegistration->add(new \Criteria('ip', $regIp));
                }
            }
            $crRegistration->setSort($sortBy);
            $crRegistration->setOrder($orderBy);
            $registrationsCount = $this->getCount($crRegistration);
            $GLOBALS['xoopsTpl']->assign('registrationsCount', $registrationsCount);
            $registrationsAll = $this->getAll($crRegistration);
            if ($registrationsCount > 0) {
                // Get All Registration
                foreach (\array_keys($registrationsAll) as $regId) {
                    $registerValues = $registrationsAll[$regId]->getValuesRegistrations();
                    $registrations[$regId] = $registrationsAll[$regId]->getValuesRegistrations();
                    $registrations[$regId]['id'] = $regId;
                    $registrations[$regId]['evid'] = $evId;
                    if ($registerValues['submitter'] > 0) {
                        $registrations[$regId]['submitter_text'] = $registerValues['submitter_text'];
                    } else {
                        $registrations[$regId]['submitter_text'] = $registerValues['ip'];
                    }
                    $registrations[$regId]['permRegistrationEdit'] = $permissionsHandler->getPermRegistrationsEdit(
                                                                            $registerValues['ip'],
                                                                            $registerValues['submitter'],
                                                                            $evSubmitter,
                                                                            $evStatus,
                                                                        );
                    $permRegistrationApprove = $permissionsHandler->getPermRegistrationsApprove($evSubmitter, $evStatus);
                    $registrations[$regId]['permRegistrationApprove'] = $permRegistrationApprove;
                    $registrations[$regId]['permRegistrationConfirm'] = ($permRegistrationApprove && (int)$registerValues['status'] < Constants::STATUS_APPROVED);

                    // get all answers for this event
                    $answers = $answerHandler->getAnswersDetailsByRegistration($regId, $questionsArr);
                    $registrations[$regId]['answers'] = $answers;
                }
                return $registrations;

            }
        }
        return false;
    }

    /**
     * compare two versions of registration
     * @param  $versionOld
     * @param  $regIdNew
     * @return string
     */
    public function getRegistrationsCompare($versionOld, $regIdNew)
    {
        $versionNew = $this->get($regIdNew);
        $infotext = '';
        $fields = [];
        $fields[] = ['name' => 'firstname', 'caption' => \_MA_WGEVENTS_REGISTRATION_FIRSTNAME, 'type' => 'text'];
        $fields[] = ['name' => 'lastname', 'caption' => \_MA_WGEVENTS_REGISTRATION_LASTNAME, 'type' => 'text'];
        $fields[] = ['name' => 'email', 'caption' => \_MA_WGEVENTS_REGISTRATION_EMAIL, 'type' => 'text'];
        $fields[] = ['name' => 'paidamount', 'caption' => \_MA_WGEVENTS_REGISTRATION_PAIDAMOUNT, 'type' => 'float'];
        foreach ($fields as $field) {
            $valueOld = $versionOld->getVar($field['name']);
            $valueNew = $versionNew->getVar($field['name']);
            if ($valueOld != $valueNew) {
                switch ($field['type']) {
                    case 'text':
                    default:
                        $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, $field['caption'], $valueOld, $valueNew) . PHP_EOL;

It seems like $valueNew can also be of type array and array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

                        break;
                    case 'datetime':
                        $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, $field['caption'], \formatTimestamp($valueOld, 'm'), \formatTimestamp($valueNew, 'm')) . PHP_EOL;
                        break;
                    case 'float':
                        $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, $field['caption'], Utility::FloatToString($valueOld), Utility::FloatToString($valueNew)) . PHP_EOL;
                        break;
                }
            }
        }
        unset($fields, $field);

        $field = 'listwait';
        $valueOld = $versionOld->getVar($field);
        $valueNew = $versionNew->getVar($field);
        if ($valueOld != $valueNew) {
            $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, \_MA_WGEVENTS_REGISTRATION_LISTWAIT, Utility::getListWaitText($valueOld), Utility::getListWaitText($valueNew)) . PHP_EOL;
        }
        $field = 'status';
        $valueOld = $versionOld->getVar($field);
        $valueNew = $versionNew->getVar($field);
        if ($valueOld != $valueNew) {
            $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, \_MA_WGEVENTS_STATUS, Utility::getStatusText($valueOld), Utility::getStatusText($valueNew)) . PHP_EOL;
        }
        $field = 'financial';
        $valueOld = $versionOld->getVar($field);
        $valueNew = $versionNew->getVar($field);
        if ($valueOld != $valueNew) {
            $infotext .= \sprintf(\_MA_WGEVENTS_MAIL_REG_MODIFICATION, \_MA_WGEVENTS_REGISTRATION_FINANCIAL, Utility::getFinancialText($valueOld), Utility::getFinancialText($valueNew)) . PHP_EOL;
        }

        return $infotext;
    }

}