XoopsModules25x / xhelp

class/DepartmentMailBoxHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Xhelp;

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

/**
 * @copyright    {@link https://xoops.org/ XOOPS Project}
 * @license      {@link https://www.gnu.org/licenses/gpl-2.0.html GNU GPL 2 or later}
 * @author       Nazar Aziz <nazar@panthersoftware.com>
 * @author       XOOPS Development Team
 */

if (!\defined('XHELP_CLASS_PATH')) {
    exit();
}

// require_once XHELP_CLASS_PATH . '/BaseObjectHandler.php';
// require_once XHELP_CLASS_PATH . '/mailbox.php';
// require_once XHELP_CLASS_PATH . '/mailboxPOP3.php';

/**
 * DepartmentMailBoxHandler class
 *
 * Methods to work store / retrieve DepartmentMailBoxServer
 * objects from the database
 */
class DepartmentMailBoxHandler extends BaseObjectHandler
{
    /**
     * Name of child class
     *
     * @var string
     */
    public $classname = DepartmentMailBox::class;
    /**
     * DB table name
     *
     * @var string
     */
    public $dbtable = 'xhelp_department_mailbox';

    private const TABLE = 'xhelp_department_mailbox';
    private const ENTITY = DepartmentMailBox::class;
    private const ENTITYNAME = 'DepartmentMailBox';
    private const KEYNAME = 'id';
    private const IDENTIFIER = 'departmentid';

    /**
     * Constructor
     *
     * @param \XoopsMySQLDatabase|null $db reference to a xoopsDB object
     */
    public function __construct(\XoopsMySQLDatabase $db = null)
    {
        $this->init($db);
        $this->helper = Helper::getInstance();
        parent::__construct($db, static::TABLE, static::ENTITY, static::KEYNAME, static::IDENTIFIER);
    }

    /**
     * retrieve server list by department
     * @param int $depid department id
     * @return array array of {@link DepartmentMailBox}
     */
    public function &getByDepartment(int $depid): array
    {
        $ret   = [];
        $depid = $depid;
        if ($depid > 0) {
            $criteria = new \Criteria('departmentid', (string)$depid);
            $criteria->setSort('priority');
            $total = $this->getCount($criteria);

            if ($total > 0) {
                $ret = $this->getObjects($criteria);

                return $ret;
            }
        }

        return $ret;
    }

    /**
     * @return array
     */
    public function &getActiveMailboxes(): array
    {
        $criteria = new \Criteria('active', '1');
        $ret      = $this->getObjects($criteria);

        return $ret;
    }

    /**
     * creates new email server entry for department
     *
     * @param int $depid
     * @return bool
     */
    public function addEmailServer(int $depid): bool
    {
        /** @var \XoopsModules\Xhelp\DepartmentMailBox $server */
        $server = $this->create();
        $server->setVar('departmentid', $depid);

        return $this->insert($server);
    }

    /**
     * remove an email server
     *
     * @param \XoopsObject $object      {@link DepartmentMailBox}
     *                                  Mailbox to delete
     * @param bool         $force       Should bypass XOOPS delete restrictions
     * @return bool True on Successful delete
     */
    public function delete(\XoopsObject $object, $force = false): bool
    {
        $helper = Helper::getInstance();
        //Remove all Mail Events for mailbox
        /** @var \XoopsModules\Xhelp\MailEventHandler $mailEventHandler */
        $mailEventHandler = $helper->getHandler('MailEvent');
        $criteria         = new \Criteria('mbox_id', $object->getVar('id'));

It seems like $object->getVar('id') can also be of type array and array; however, parameter $value of Criteria::__construct() does only seem to accept string, maybe add an additional type check?

        $mailEventHandler->deleteAll($criteria);

        $ret = parent::delete($object, $force);

        return $ret;
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function insertQuery(\XoopsObject $object): string
    {
        //TODO mb replace with individual variables
        // Copy all object vars into local variables
        foreach ($object->cleanVars as $k => $v) {
            ${$k} = $v;
        }

        $sql = \sprintf(
            'INSERT INTO `%s` (id, departmentid, SERVER, serverport, username, PASSWORD, priority, emailaddress, mboxtype, active) VALUES (%u, %u, %s, %u, %s, %s, %u, %s, %u, %u)',
            $this->db->prefix($this->dbtable),
            $id,

The variable $id seems to be never defined.

            $departmentid,

The variable $departmentid seems to be never defined.

            $this->db->quoteString($server),

The variable $server seems to be never defined.

            $serverport,

The variable $serverport seems to be never defined.

            $this->db->quoteString($username),

The variable $username seems to be never defined.

            $this->db->quoteString($password),

The variable $password seems to be never defined.

            $priority,

The variable $priority seems to be never defined.

            $this->db->quoteString($emailaddress),

The variable $emailaddress seems to be never defined.

            $mboxtype,

The variable $mboxtype seems to be never defined.

            $active

The variable $active seems to be never defined.

        );

        return $sql;
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function updateQuery(\XoopsObject $object): string
    {
        //TODO mb replace with individual variables
        // Copy all object vars into local variables
        foreach ($object->cleanVars as $k => $v) {
            ${$k} = $v;
        }

        $sql = \sprintf(
            'UPDATE `%s` SET departmentid = %u, SERVER = %s, serverport = %u, username = %s, PASSWORD = %s, priority = %u, emailaddress = %s, mboxtype = %u, active = %u WHERE id = %u',
            $this->db->prefix($this->dbtable),
            $departmentid,

The variable $departmentid seems to be never defined.

            $this->db->quoteString($server),

The variable $server seems to be never defined.

            $serverport,

The variable $serverport seems to be never defined.

            $this->db->quoteString($username),

The variable $username seems to be never defined.

            $this->db->quoteString($password),

The variable $password seems to be never defined.

            $priority,

The variable $priority seems to be never defined.

            $this->db->quoteString($emailaddress),

The variable $emailaddress seems to be never defined.

            $mboxtype,

The variable $mboxtype seems to be never defined.

            $active,

The variable $active seems to be never defined.

            $id

The variable $id seems to be never defined.

        );

        return $sql;
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function deleteQuery(\XoopsObject $object): string
    {
        $sql = \sprintf('DELETE FROM `%s` WHERE id = %u', $this->db->prefix($this->dbtable), $object->getVar('id'));

It seems like $object->getVar('id') 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?

        return $sql;
    }
}