XoopsModules25x / suico

class/FieldHandler.php

<?php

declare(strict_types=1);

namespace XoopsModules\Suico;

/**
 * Extended User Profile
 *
 * 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       (c) 2000-2016 XOOPS Project (www.xoops.org)
 * @license             GNU GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package             profile
 * @since               2.3.0
 * @author              Jan Pedersen
 * @author              Taiwen Jiang <phppp@users.sourceforge.net>
 */

/**
 * @package             kernel
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 */
class FieldHandler extends \XoopsPersistableObjectHandler
{
    /**
     * @param \XoopsDatabase $db
     */
    public function __construct(\XoopsDatabase $db)
    {
        parent::__construct($db, 'suico_profile_field', Field::class, 'field_id', 'field_title');
    }

    /**
     * Read field information from cached storage
     *
     * @param bool $force_update read fields from database and not cached storage
     *
     * @return array
     */
    public function loadFields($force_update = false)
    {
        static $fields = [];
        if (!empty($force_update) || 0 == \count($fields)) {
            $this->table_link = $this->db->prefix('suico_profile_category');

The property table_link does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $criteria         = new \Criteria('o.field_id', 0, '!=');
            $criteria->setSort('l.cat_weight ASC, o.field_weight');
            $field_objs = &$this->getByLink($criteria, ['o.*'], true, 'cat_id', 'cat_id');
            foreach (\array_keys($field_objs) as $i) {
                $fields[$field_objs[$i]->getVar('field_name')] = $field_objs[$i];
            }
        }
        return $fields;
    }

    /**
     * save a profile field in the database
     *
     * @param \XoopsObject $obj   reference to the object
     * @param bool         $force whether to force the query execution despite security settings
     *
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     * @internal param bool $checkObject check if the object is dirty and clean the attributes
     */
    public function insert(\XoopsObject $obj, $force = false)
    {
        if (!($obj instanceof $this->className)) {
            return false;
        }
        /* @var ProfileProfileHandler $profileHandler */
        $profileHandler = \XoopsModules\Suico\Helper::getInstance()->getHandler('Profile');
        $obj->setVar('field_name', \str_replace(' ', '_', $obj->getVar('field_name')));
        $obj->cleanVars();
        $defaultstring = '';
        switch ($obj->getVar('field_type')) {
            case 'datetime':
            case 'date':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_INT);
                $obj->setVar('field_maxlength', 10);
                break;
            case 'longdate':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_MTIME);
                break;
            case 'yesno':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_INT);
                $obj->setVar('field_maxlength', 1);
                break;
            case 'textbox':
                if (\XOBJ_DTYPE_INT != $obj->getVar('field_valuetype')) {
                    $obj->setVar('field_valuetype', \XOBJ_DTYPE_TXTBOX);
                }
                break;
            case 'autotext':
                if (\XOBJ_DTYPE_INT != $obj->getVar('field_valuetype')) {
                    $obj->setVar('field_valuetype', \XOBJ_DTYPE_TXTAREA);
                }
                break;
            case 'group_multi':
            case 'select_multi':
            case 'checkbox':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_ARRAY);
                break;
            case 'language':
            case 'timezone':
            case 'theme':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_TXTBOX);
                break;
            case 'dhtml':
            case 'textarea':
                $obj->setVar('field_valuetype', \XOBJ_DTYPE_TXTAREA);
                break;
        }
        if ('' === $obj->getVar('field_valuetype')) {
            $obj->setVar('field_valuetype', \XOBJ_DTYPE_TXTBOX);
        }
        if ((!\in_array($obj->getVar('field_name'), $this->getUserVars())) && isset($_REQUEST['field_required'])) {
            if ($obj->isNew()) {
                //add column to table
                $changetype = 'ADD';
            } else {
                //update column information
                $changetype = 'MODIFY COLUMN';
            }
            $maxlengthstring = $obj->getVar('field_maxlength') > 0 ? '(' . $obj->getVar('field_maxlength') . ')' : '';
            //set type
            switch ($obj->getVar('field_valuetype')) {
                default:
                case \XOBJ_DTYPE_ARRAY:
                case \XOBJ_DTYPE_UNICODE_ARRAY:
                    $type            = 'mediumtext';
                    $maxlengthstring = '';
                    break;
                case \XOBJ_DTYPE_UNICODE_EMAIL:
                case \XOBJ_DTYPE_UNICODE_TXTBOX:
                case \XOBJ_DTYPE_UNICODE_URL:
                case \XOBJ_DTYPE_EMAIL:
                case \XOBJ_DTYPE_TXTBOX:
                case \XOBJ_DTYPE_URL:
                    $type = 'varchar';
                    // varchars must have a maxlength
                    if (!$maxlengthstring) {
                        //so set it to max if maxlength is not set - or should it fail?
                        $maxlengthstring = '(255)';
                        $obj->setVar('field_maxlength', 255);
                    }
                    break;
                case \XOBJ_DTYPE_INT:
                    $type = 'int';
                    break;
                case \XOBJ_DTYPE_DECIMAL:
                    $type = 'decimal(14,6)';
                    break;
                case \XOBJ_DTYPE_FLOAT:
                    $type = 'float(15,9)';
                    break;
                case \XOBJ_DTYPE_OTHER:
                case \XOBJ_DTYPE_UNICODE_TXTAREA:
                case \XOBJ_DTYPE_TXTAREA:
                    $type            = 'text';
                    $maxlengthstring = '';
                    break;
                case \XOBJ_DTYPE_MTIME:
                    $type            = 'date';
                    $maxlengthstring = '';
                    break;
            }
            $sql    = 'ALTER TABLE `' . $profileHandler->table . '` ' . $changetype . ' `' . $obj->cleanVars['field_name'] . '` ' . $type . $maxlengthstring . ' NULL';
            $result = $force ? $this->db->queryF($sql) : $this->db->query($sql);
            if (!$result) {
                $obj->setErrors($this->db->error());
                return false;
            }
        }
        //change this to also update the cached field information storage
        $obj->setDirty();
        if (!parent::insert($obj, $force)) {
            return false;
        }
        return $obj->getVar('field_id');

The expression return $obj->getVar('field_id') also could return the type array|string which is incompatible with the documented return type boolean.

    }

    /**
     * delete a profile field from the database
     *
     * @param \XoopsObject $obj reference to the object to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */
    public function delete(\XoopsObject $obj, $force = false)
    {
        if (!($obj instanceof $this->className)) {
            return false;
        }
        /* @var ProfileProfileHandler $profileHandler */
        $profileHandler = \XoopsModules\Suico\Helper::getInstance()->getHandler('Profile');
        // remove column from table
        $sql = 'ALTER TABLE ' . $profileHandler->table . ' DROP `' . $obj->getVar('field_name', 'n') . '`';
        if ($this->db->query($sql)) {
            //change this to update the cached field information storage
            if (!parent::delete($obj, $force)) {
                return false;
            }
            if ($obj->getVar('field_show') || $obj->getVar('field_edit')) {
                /* @var XoopsModuleHandler $moduleHandler */
                $moduleHandler = \xoops_getHandler('module');
                $suico_module  = $moduleHandler->getByDirname('suico');
                if (\is_object($suico_module)) {
                    // Remove group permissions
                    /* @var XoopsGroupPermHandler $grouppermHandler */
                    $grouppermHandler = \xoops_getHandler('groupperm');
                    $criteria         = new \CriteriaCompo(new \Criteria('gperm_modid', $suico_module->getVar('mid')));
                    $criteria->add(new \Criteria('gperm_itemid', $obj->getVar('field_id')));
                    return $grouppermHandler->deleteAll($criteria);
                }
            }
        }
        return false;
    }

    /**
     * Get array of standard variable names (user table)
     *
     * @return array
     */
    public function getUserVars()
    {
        return [
            'uid',
            'uname',
            'name',
            'email',
            'url',
            'user_avatar',
            'user_regdate',
            'user_from',
            'user_sig',
            'user_viewemail',
            'actkey',
            'pass',
            'posts',
            'attachsig',
            'rank',
            'level',
            'theme',
            'timezone_offset',
            'last_login',
            'umode',
            'uorder',
            'notify_method',
            'notify_mode',
            'user_occ',
            'bio',
            'user_intrest',
            'user_mailok',
        ];
    }
}