FriendshipHandler::delete() - Code Metrics - Inspection of "updates" - XoopsModules25x/suico - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#81)

by Michael
created 2020-04-28 19:40 UTC
FriendshipHandler::delete() A

↳ Parent: FriendshipHandler
Complexity

Conditions	4
Paths	5
Size

Total Lines	22
Code Lines	13
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	13
c	0
b	0
f	0
dl	0
loc	22
rs	9.8333
cc	4
nc	5
nop	2
<?php

declare(strict_types=1);

namespace XoopsModules\Yogurt;

/*
 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.
*/
/**
 * Module: Yogurt
 *
 * @category        Module
 * @package         yogurt
 * @author          Marcello Brandão aka  Suico, Mamba, LioMJ  <https://xoops.org>
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 */

// Friendship.php,v 1
//  ---------------------------------------------------------------- //
// Author: Bruno Barthez                                               //
// ----------------------------------------------------------------- //

use Criteria;
use CriteriaCompo;
use CriteriaElement;
use XoopsDatabase;
use XoopsFormButton;
use XoopsFormHidden;
use XoopsFormLabel;
use XoopsFormRadio;
use XoopsFormRadioYN;
use XoopsObject;
use XoopsPersistableObjectHandler;
use XoopsThemeForm;

require_once XOOPS_ROOT_PATH . '/kernel/object.php';
/**
 * Includes of form objects and uploader
 */
require_once XOOPS_ROOT_PATH . '/class/uploader.php';
require_once XOOPS_ROOT_PATH . '/kernel/object.php';
require_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
require_once XOOPS_ROOT_PATH . '/kernel/object.php';

// -------------------------------------------------------------------------
// ------------------Friendship user handler class -------------------
// -------------------------------------------------------------------------

/**
 * yogurt_friendshiphandler class.
 * This class provides simple mecanisme for Friendship object
 */
class FriendshipHandler extends XoopsPersistableObjectHandler
{
    public $helper;

    public $isAdmin;

    /**
     * Constructor
     * @param \XoopsDatabase|null              $xoopsDatabase
     * @param \XoopsModules\Yogurt\Helper|null $helper
     */
    public function __construct(
        ?XoopsDatabase $xoopsDatabase = null,
        $helper = null
    ) {
        /** @var \XoopsModules\Yogurt\Helper $this ->helper */
        if (null === $helper) {
            $this->helper = Helper::getInstance();

        } else {
            $this->helper = $helper;
        }
        $isAdmin = $this->helper->isUserAdmin();

        parent::__construct($xoopsDatabase, 'yogurt_friendships', Friendship::class, 'friendship_id', 'friendship_id');
    }

    /**
     * create a new Groups
     *
     * @param bool $isNew flag the new objects as "new"?
     * @return \XoopsObject Groups
     */
    public function create(
        $isNew = true
    ) {
        $obj = parent::create($isNew);
        if ($isNew) {
            $obj->setNew();
        } else {
            $obj->unsetNew();
        }
        $obj->helper = $this->helper;

        return $obj;
    }

    /**
     * retrieve a Friendship
     *
     * @param int  $id of the Friendship
     * @param null $fields

     * @return mixed reference to the {@link Friendship} object, FALSE if failed
     */
    public function get2(
        $id = null,
        $fields = null
        /** @scrutinizer ignore-unused */ $fields = null
    ) {
        $sql = 'SELECT * FROM ' . $this->db->prefix('yogurt_friendships') . ' WHERE friendship_id=' . $id;
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        $numrows = $this->db->getRowsNum($result);
        if (1 === $numrows) {
            $yogurt_friendship = new Friendship();
            $yogurt_friendship->assignVars($this->db->fetchArray($result));

            return $yogurt_friendship;
        }

        return false;
    }

    /**
     * insert a new Friendship in the database
     *
     * @param \XoopsObject $xoopsObject       reference to the {@link Friendship}
     *                                        object
     * @param bool         $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */
    public function insert2(
        XoopsObject $xoopsObject,
        $force = false
    ) {
        global $xoopsConfig;
        if (!$xoopsObject instanceof Friendship) {
            return false;
        }
        if (!$xoopsObject->isDirty()) {
            return true;
        }
        if (!$xoopsObject->cleanVars()) {
            return false;
        }

        $friendship_id = $friend1_uid = $friend2_uid = $level = $hot = $trust = $cool = $fan = '';

        foreach ($xoopsObject->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        //        $now = 'date_add(now(), interval ' . $xoopsConfig['server_TZ'] . ' hour)';

        if ($xoopsObject->isNew()) {
            // ajout/modification d'un Friendship
            $xoopsObject = new Friendship();
            $format      = 'INSERT INTO %s (friendship_id, friend1_uid, friend2_uid, LEVEL, hot, trust, cool, fan)';
            $format      .= 'VALUES (%u, %u, %u, %u, %u, %u, %u, %u)';
            $sql         = \sprintf(
                $format,
                $this->db->prefix('yogurt_friendships'),
                $friendship_id,
                $friend1_uid,
                $friend2_uid,
                $level,
                $hot,
                $trust,
                $cool,
                $fan
            );
            $force       = true;
        } else {
            $format = 'UPDATE %s SET ';
            $format .= 'friendship_id=%u, friend1_uid=%u, friend2_uid=%u, level=%u, hot=%u, trust=%u, cool=%u, fan=%u';
            $format .= ' WHERE friendship_id = %u';
            $sql    = \sprintf(
                $format,
                $this->db->prefix('yogurt_friendships'),
                $friendship_id,
                $friend1_uid,
                $friend2_uid,
                $level,
                $hot,
                $trust,
                $cool,
                $fan,
                $friendship_id
            );
        }
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }
        if (empty($friendship_id)) {

            $friendship_id = $this->db->getInsertId();
        }
        $xoopsObject->assignVar('friendship_id', $friendship_id);

        return true;
    }

    /**
     * delete a Friendship from the database
     *
     * @param \XoopsObject $xoopsObject reference to the Friendship to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */
    public function delete(
        XoopsObject $xoopsObject,
        $force = false
    ) {
        if (!$xoopsObject instanceof Friendship) {
            return false;
        }
        $sql = \sprintf(
            'DELETE FROM %s WHERE friendship_id = %u',
            $this->db->prefix('yogurt_friendships'),
            $xoopsObject->getVar('friendship_id')
            /** @scrutinizer ignore-type */ $xoopsObject->getVar('friendship_id')
        );
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }

        return true;
    }

    /**
     * retrieve yogurt_friendships from the database
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement} conditions to be met
     * @param bool                                 $id_as_key       use the UID as key for the array?
     * @param bool                                 $as_object
     * @return array array of {@link Friendship} objects
     */
    public function &getObjects(
        ?CriteriaElement $criteriaElement = null,
        $id_as_key = false,
        $as_object = true
    ) {
        $ret   = [];
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('yogurt_friendships');
        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();
            $sql .= ' ' . $criteriaElement->/** @scrutinizer ignore-call */ renderWhere();
            if ('' !== $criteriaElement->getSort()) {
                $sql .= ' ORDER BY ' . $criteriaElement->getSort() . ' ' . $criteriaElement->getOrder();
            }
            $limit = $criteriaElement->getLimit();
            $start = $criteriaElement->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $yogurt_friendship = new Friendship();
            $yogurt_friendship->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] = &$yogurt_friendship;
            } else {
                $ret[$myrow['friendship_id']] = &$yogurt_friendship;
            }
            unset($yogurt_friendship);
        }

        return $ret;
    }

    /**
     * count yogurt_friendships matching a condition
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement} to match
     * @return int count of yogurt_friendships
     */
    public function getCount(
        ?CriteriaElement $criteriaElement = null
    ) {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('yogurt_friendships');
        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();
        }
        $result = $this->db->query($sql);
        if (!$result) {
            return 0;
        }
        [$count] = $this->db->fetchRow($result);

        return (int)$count;
    }

    /**
     * delete yogurt_friendships matching a set of conditions
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement}
     * @param bool                                 $force
     * @param bool                                 $asObject
     * @return bool FALSE if deletion failed
     */
    public function deleteAll(
        ?CriteriaElement $criteriaElement = null,
        $force = true,
        $asObject = false
    ) {
        $sql = 'DELETE FROM ' . $this->db->prefix('yogurt_friendships');
        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {

            return false;
        }

        return true;
    }

    /**
     * @param      $nbfriends
     * @param null $criteria

     * @param int  $shuffle
     * @return array
     */
    public function getFriends(
        $nbfriends,
        $criteria = null,
        $shuffle = 1
    ) {
        $ret   = [];

        $limit = $start = 0;

        $sql   = 'SELECT uname, user_avatar, friend2_uid FROM ' . $this->db->prefix(
                'yogurt_friendships'
            ) . ', ' . $this->db->prefix(
                'users'
            );
        if (isset($criteria) && $criteria instanceof CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
            //attention here this is kind of a hack
            $sql .= ' AND uid = friend2_uid ';
            if ('' !== $criteria->getSort()) {
                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
            }

            $limit = $criteria->getLimit();
            $start = $criteria->getStart();

            $result = $this->db->query($sql, $limit, $start);
            $vetor  = [];
            $i      = 0;

            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $vetor[$i]['uid']         = $myrow['friend2_uid'];
                $vetor[$i]['uname']       = $myrow['uname'];
                $vetor[$i]['user_avatar'] = $myrow['user_avatar'];
                $i++;
            }
            if (1 === $shuffle) {
                \shuffle($vetor);
                $vetor = \array_slice($vetor, 0, $nbfriends);
            }

            return $vetor;
        }
    }

    /**
     * @param      $nbfriends
     * @param null $criteria

     * @param int  $shuffle
     * @return array
     */
    public function getFans(
        $nbfriends,
        $criteria = null,
        $shuffle = 1
    ) {
        $ret   = [];

        $limit = $start = 0;

        $sql   = 'SELECT uname, user_avatar, friend1_uid FROM ' . $this->db->prefix(
                'yogurt_friendships'
            ) . ', ' . $this->db->prefix(
                'users'
            );
        if (isset($criteria) && $criteria instanceof CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
            //attention here this is kind of a hack
            $sql .= ' AND uid = friend1_uid ';
            if ('' !== $criteria->getSort()) {
                $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
            }

            $limit = $criteria->getLimit();
            $start = $criteria->getStart();

            $result = $this->db->query($sql, $limit, $start);
            $vetor  = [];
            $i      = 0;

            while (false !== ($myrow = $this->db->fetchArray($result))) {
                $vetor[$i]['uid']         = $myrow['friend1_uid'];
                $vetor[$i]['uname']       = $myrow['uname'];
                $vetor[$i]['user_avatar'] = $myrow['user_avatar'];
                $i++;
            }
            if (1 === $shuffle) {
                \shuffle($vetor);
                $vetor = \array_slice($vetor, 0, $nbfriends);
            }

            return $vetor;
        }
    }

    /**
     * @param $friend
     */
    public function renderFormSubmit($friend)
    {
        global $xoopsUser;
        /**
         * criteria fetch friendship to be edited
         */
        $criteria_friend1 = new Criteria(
            'friend1_uid', $xoopsUser->getVar(
            'uid'
        )
        );

        $field_friend_fan = $field_friend_friendly = $field_friend_funny = $field_friend_cool = '';

        $criteria_friend2    = new Criteria('friend2_uid', $friend->getVar('uid'));
        $criteria_friendship = new CriteriaCompo($criteria_friend1);
        $criteria_friendship->add($criteria_friend2);
        $friendships = $this->getObjects($criteria_friendship);
        $friendship  = $friendships[0];

        $form = new XoopsThemeForm(
            \_MD_YOGURT_EDIT_FRIENDSHIP, 'form_editfriendship', 'editfriendship.php', 'post', true
        );
        //$field_friend_avatar      = new XoopsFormLabel(_MD_YOGURT_PHOTO, "<img src=../../uploads/".$friend->getVar('user_avatar').">");
        if ('avatars/blank.gif' === $friend->getVar(
                'user_avatar'
            )) {
            $field_friend_avatar = new XoopsFormLabel(\_MD_YOGURT_PHOTO, '<img src=assets/images/noavatar.gif>');
        } else {
            $field_friend_avatar = new XoopsFormLabel(
                \_MD_YOGURT_PHOTO, '<img src=../../uploads/' . $friend->getVar(
                                     'user_avatar'
                                 ) . '>'
            );
        }
        $field_friend_name = new XoopsFormLabel(\_MD_YOGURT_FRIENDNAME, $friend->getVar('uname'));

        if (1 === $this->helper->getConfig('allow_friendshiplevel')) {
            $field_friend_level = new XoopsFormRadio(\_MD_YOGURT_LEVEL, 'level', $friendship->getVar('level'), '<br>');

            $field_friend_level->addOption('1', \_MD_YOGURT_UNKNOWN_ACCEPTED);
            $field_friend_level->addOption('3', \_MD_YOGURT_AQUAITANCE);
            $field_friend_level->addOption('5', \_MD_YOGURT_FRIEND);
            $field_friend_level->addOption('7', \_MD_YOGURT_BESTFRIEND);
        }

        if (1 === $this->helper->getConfig('allow_fanssevaluation')) {
            $field_friend_fan = new XoopsFormRadioYN(
                \_MD_YOGURT_FAN, 'fan', $friendship->getVar(
                'fan'
            ), '<img src="assets/images/fans.gif" alt="' . \_YES . '" title="' . \_YES . '">', '<img src="assets/images/fansbw.gif" alt="' . \_NO . '" title="' . \_NO . '">'
            );

            $field_friend_friendly = new XoopsFormRadio(\_MD_YOGURT_FRIENDLY, 'hot', $friendship->getVar('hot'));
            $field_friend_friendly->addOption(
                '1',
                '<img src="assets/images/friendlya.gif" alt="' . \_MD_YOGURT_FRIENDLYNO . '" title="' . \_MD_YOGURT_FRIENDLYNO . '">'
            );
            $field_friend_friendly->addOption(
                '2',
                '<img src="assets/images/friendlyb.gif" alt="' . \_MD_YOGURT_FRIENDLYYES . '" title="' . \_MD_YOGURT_FRIENDLYYES . '">'
            );
            $field_friend_friendly->addOption(
                '3',
                '<img src="assets/images/friendlyc.gif" alt="' . \_MD_YOGURT_FRIENDLYALOT . '" title="' . \_MD_YOGURT_FRIENDLYALOT . '">'
            );

            $field_friend_funny = new XoopsFormRadio(\_MD_YOGURT_FUNNY, 'trust', $friendship->getVar('trust'));
            $field_friend_funny->addOption(
                '1',
                '<img src="assets/images/funnya.gif" alt="' . \_MD_YOGURT_FUNNYNO . '" title="' . \_MD_YOGURT_FUNNYNO . '">'
            );
            $field_friend_funny->addOption(
                '2',
                '<img src="assets/images/funnyb.gif" alt="' . \_MD_YOGURT_FUNNYYES . '" title="' . \_MD_YOGURT_FUNNYYES . '">'
            );
            $field_friend_funny->addOption(
                '3',
                '<img src="assets/images/funnyc.gif" alt="' . \_MD_YOGURT_FUNNYALOT . '" title="' . \_MD_YOGURT_FUNNYALOT . '">'
            );

            $field_friend_cool = new XoopsFormRadio(\_MD_YOGURT_COOL, 'cool', $friendship->getVar('cool'));
            $field_friend_cool->addOption(
                '1',
                '<img src="assets/images/coola.gif" alt="' . \_MD_YOGURT_COOLNO . '" title="' . \_MD_YOGURT_COOLNO . '">'
            );
            $field_friend_cool->addOption(
                '2',
                '<img src="assets/images/coolb.gif" alt="' . \_MD_YOGURT_COOLYES . '" title="' . \_MD_YOGURT_COOLYES . '">'
            );
            $field_friend_cool->addOption(
                '3',
                '<img src="assets/images/coolc.gif" alt="' . \_MD_YOGURT_COOLALOT . '" title="' . \_MD_YOGURT_COOLALOT . '">'
            );
        }
        $form->setExtra('enctype="multipart/form-data"');
        $buttonSend                 = new XoopsFormButton('', 'submit_button', \_MD_YOGURT_UPDATEFRIEND, 'submit');
        $field_friend_friendid      = new XoopsFormHidden('friend_uid', $friend->getVar('uid'));
        $field_friend_marker        = new XoopsFormHidden('marker', '1');
        $field_friend_friendshio_id = new XoopsFormHidden('friendship_id', $friendship->getVar('friendship_id'));
        $form->addElement($field_friend_friendid);
        $form->addElement($field_friend_friendshio_id);
        $form->addElement($field_friend_marker);
        $form->addElement($field_friend_avatar);
        $form->addElement($field_friend_name);
        $form->addElement($field_friend_level);

        $form->addElement($field_friend_fan);
        $form->addElement($field_friend_friendly);
        $form->addElement($field_friend_funny);
        $form->addElement($field_friend_cool);

        $form->addElement($buttonSend);

        $form->display();
    }

    /**
     * Get the averages of each evaluation hot funny etc...
     *
     * @param int $user_uid
     * @return array with averages
     */
    public function getMoyennes(
        $user_uid
    ) {
        global $xoopsUser;

        $vetor               = [];
        $vetor['mediahot']   = 0;
        $vetor['mediatrust'] = 0;
        $vetor['mediacool']  = 0;
        $vetor['sumfan']     = 0;

        //Calculating avg(hot)
        $sql    = 'SELECT friend2_uid, Avg(hot) AS mediahot FROM ' . $this->db->prefix(
                'yogurt_friendships'
            );
        $sql    .= ' WHERE  (hot>0) GROUP BY friend2_uid HAVING (friend2_uid=' . $user_uid . ') ';
        $result = $this->db->query($sql);
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $vetor['mediahot'] = $myrow['mediahot'] * 16;
        }

        //Calculating avg(trust)
        $sql    = 'SELECT friend2_uid, Avg(trust) AS mediatrust FROM ' . $this->db->prefix(
                'yogurt_friendships'
            );
        $sql    .= ' WHERE  (trust>0) GROUP BY friend2_uid HAVING (friend2_uid=' . $user_uid . ') ';
        $result = $this->db->query($sql);
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $vetor['mediatrust'] = $myrow['mediatrust'] * 16;
        }
        //Calculating avg(cool)
        $sql    = 'SELECT friend2_uid, Avg(cool) AS mediacool FROM ' . $this->db->prefix(
                'yogurt_friendships'
            );
        $sql    .= ' WHERE  (cool>0) GROUP BY friend2_uid HAVING (friend2_uid=' . $user_uid . ') ';
        $result = $this->db->query($sql);
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $vetor['mediacool'] = $myrow['mediacool'] * 16;
        }

        //Calculating sum(fans)
        $sql    = 'SELECT friend2_uid, Sum(fan) AS sumfan FROM ' . $this->db->prefix(
                'yogurt_friendships'
            );
        $sql    .= ' GROUP BY friend2_uid HAVING (friend2_uid=' . $user_uid . ') ';
        $result = $this->db->query($sql);
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $vetor['sumfan'] = $myrow['sumfan'];
        }

        return $vetor;
    }
}

XoopsModules25x / suico

Pull Request — master (#81)

FriendshipHandler::delete() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
