XfguestbookMsg::__construct() - Code Metrics - Inspection of "3.10. FINAL" - XoopsModules25x/xfguestbook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Michael

created 2017-01-24 06:56 UTC

XfguestbookMsg::__construct() A

↳ Parent: XfguestbookMsg

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	18
nc	1
nop	0
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0

<?php

//
//  ------------------------------------------------------------------------ //
//                XOOPS - PHP Content Management System                      //
//                  Copyright (c) 2000-2016 XOOPS.org                        //
//                         <http://xoops.org/>                               //
// ------------------------------------------------------------------------- //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  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.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //

defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');

/**
 * Class XfguestbookMsg
 */
class XfguestbookMsg extends XoopsObject
namespace YourVendor;

class YourClass { }
{
    // constructor
    /**
     * XfguestbookMsg constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->initVar('msg_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('user_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('uname', XOBJ_DTYPE_TXTBOX, '', false);
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true);
        $this->initVar('message', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('note', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('post_time', XOBJ_DTYPE_STIME, null, false);
        $this->initVar('email', XOBJ_DTYPE_EMAIL, '', false);
        $this->initVar('url', XOBJ_DTYPE_URL, '', false);
        $this->initVar('poster_ip', XOBJ_DTYPE_OTHER, '', false);
        $this->initVar('moderate', XOBJ_DTYPE_INT, null, false);
        $this->initVar('gender', XOBJ_DTYPE_TXTBOX, '', false, 1);
        $this->initVar('country', XOBJ_DTYPE_TXTBOX, '', false, 5);
        $this->initVar('photo', XOBJ_DTYPE_TXTBOX, '', false); // added v2.20
        $this->initVar('flagdir', XOBJ_DTYPE_TXTBOX, '', false); // added v2.30
        $this->initVar('other', XOBJ_DTYPE_TXTBOX, '', false); // added v2.30
    }
}

/**
 * Class XfguestbookMsgHandler
 */
class XfguestbookMsgHandler
namespace YourVendor;

class YourClass { }
{
    public $db;

    /**
     * XfguestbookMsgHandler constructor.
     * @param XoopsDatabase $db
     */
    public function __construct(XoopsDatabase $db)
    {
        $this->db = $db;
    }

    /**
     * @return XfguestbookMsg
     */
    public function create()
    {
        return new XfguestbookMsg();
    }

    /**
     * @param $id
     * @return bool|XfguestbookMsg
     */
    public function get($id)
    {
        $id = (int)$id;
        if ($id > 0) {
            $sql = 'SELECT * FROM ' . $this->db->prefix('xfguestbook_msg') . ' WHERE msg_id=' . $id;
            if (!$result = $this->db->query($sql)) {
                return false;
            }
            $numrows = $this->db->getRowsNum($result);
            if (1 == $numrows) {
                $msg = new XfguestbookMsg();
                $msg->assignVars($this->db->fetchArray($result));

                return $msg;
            }
        }

        return false;
    }

    /**
     * @param $msg
     * @return bool
     */
    public function insert(XoopsObject $msg)
    {
        if ('xfguestbookmsg' !== strtolower(get_class($msg))) {
            return false;
        }
        if (!$msg->cleanVars()) {
            return false;
        }
        foreach ($msg->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if (empty($msg_id)) {

            $msg_id = $this->db->genId('xfguestbook_msg_msg_id_seq');
            $sql    = 'INSERT INTO '
                      . $this->db->prefix('xfguestbook_msg')
                      . ' (msg_id, user_id, uname, title, message, note, post_time, email, url, poster_ip, moderate, gender, country, photo, flagdir, other) VALUES ('
                      . $msg_id
                      . ','
                      . $user_id

                      . ', '
                      . $this->db->quoteString($uname)

                      . ', '
                      . $this->db->quoteString($title)

                      . ', '
                      . $this->db->quoteString($message)

                      . ', '
                      . $this->db->quoteString($note)

                      . ', '
                      . $post_time

                      . ',  '
                      . $this->db->quoteString($email)

                      . ', '
                      . $this->db->quoteString($url)

                      . ', '
                      . $this->db->quoteString($poster_ip)

                      . ', '
                      . $moderate

                      . ', '
                      . $this->db->quoteString($gender)

                      . ', '
                      . $this->db->quoteString($country)

                      . ', '
                      . $this->db->quoteString($photo)

                      . ', '
                      . $this->db->quoteString($flagdir)

                      . ', '
                      . $this->db->quoteString($other)

                      . ')';
        } else {
            $sql = 'UPDATE '
                   . $this->db->prefix('xfguestbook_msg')
                   . ' SET user_id='
                   . $user_id
                   . ', uname='
                   . $this->db->quoteString($uname)
                   . ', title='
                   . $this->db->quoteString($title)
                   . ', message='
                   . $this->db->quoteString($message)
                   . ', note='
                   . $this->db->quoteString($note)
                   . ', email='
                   . $this->db->quoteString($email)
                   . ', url='
                   . $this->db->quoteString($url)
                   . ', moderate='
                   . $moderate
                   . ', gender='
                   . $this->db->quoteString($gender)
                   . ', country='
                   . $this->db->quoteString($country)
                   . ', photo='
                   . $this->db->quoteString($photo)
                   . ', flagdir='
                   . $this->db->quoteString($flagdir)
                   . ', other='
                   . $this->db->quoteString($other)
                   . ' WHERE msg_id='
                   . $msg_id;
        }
        if (!$result = $this->db->queryF($sql)) {
            return false;
        }
        if (empty($msg_id)) {
            $msg_id = $this->db->getInsertId();
        }
        $msg->assignVar('msg_id', $msg_id);

        return $msg_id;
    }

    /**
     * @param $msg
     * @return bool
     */
    public function delete($msg)
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        if ('xfguestbookmsg' !== strtolower(get_class($msg))) {
            return false;
        }
        $sql = sprintf('DELETE FROM %s WHERE msg_id = %u', $this->db->prefix('xfguestbook_msg'), $msg->getVar('msg_id'));
        if (isset($this->commentstable) && $this->commentstable !== '') {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            xoops_comment_delete($xoopsModule->getVar('mid'), $msg_id);

        }

        if (!$result = $this->db->query($sql)) {
            return false;
        }

        return true;
    }

    /**
     * @param  null $criteria
     * @return array
     */
    public function &getObjects($criteria = null)
    {
        $ret   = [];
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('xfguestbook_msg');
        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {

            $sql   .= ' ' . $criteria->renderWhere();
            $sort  = ($criteria->getSort() !== '') ? $criteria->getSort() : 'msg_id';
            $sql   .= ' ORDER BY ' . $sort . ' ' . $criteria->getOrder();
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while ($myrow = $this->db->fetchArray($result)) {
            $msg = new XfguestbookMsg();
            $msg->assignVars($myrow);
            $ret[] = $msg;
            unset($msg);
        }

        return $ret;
    }

    /**
     * @param  null $criteria
     * @return int
     */
    public function countMsg($criteria = null)
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('xfguestbook_msg');
        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {

            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return 0;
        }
        list($count) = $this->db->fetchRow($result);

        return $count;
    }

    /**
     * @param  null $criteria
     * @return array|bool
     */
    public function countMsgByCountry($criteria = null)
    {
        $arr = [];
        $sql = 'SELECT country, flagdir FROM ' . $this->db->prefix('xfguestbook_msg');
        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {

            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        while (list($country, $flagdir) = $this->db->fetchRow($result)) {
            $arr[] = $flagdir . '/' . $country;
        }
        $ret = array_count_values($arr);
        arsort($ret);

        return $ret;
    }

    /**
     * @param  null $criteria
     * @return array|bool
     */
    public function countMsgByGender($criteria = null)
    {
        $arr = [];
        $sql = 'SELECT gender FROM ' . $this->db->prefix('xfguestbook_msg');
        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {

            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        while (list($gender) = $this->db->fetchRow($result)) {
            $arr[] = $gender;
        }
        $ret = array_count_values($arr);

        return $ret;
    }

    /**
     * @param  null $criteria
     * @return array|int
     */
    public function getMsgImg($criteria = null)
    {
        $arr = [];
        $sql = 'SELECT photo FROM ' . $this->db->prefix('xfguestbook_msg') . " WHERE `photo` LIKE 'msg_%'";
        if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {

            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return 0;
        }
        while (list($photo) = $this->db->fetchRow($result)) {
            $arr[] = $photo;
        }

        return $arr;
    }
}


Pull Request — master (#10)

XfguestbookMsg::__construct() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-14 00:00 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 33 and the first side effect is on line 28. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			//
3			// ------------------------------------------------------------------------ //
4			// XOOPS - PHP Content Management System //
5			// Copyright (c) 2000-2016 XOOPS.org //
6			// <http://xoops.org/> //
7			// ------------------------------------------------------------------------- //
8			// This program is free software; you can redistribute it and/or modify //
9			// it under the terms of the GNU General Public License as published by //
10			// the Free Software Foundation; either version 2 of the License, or //
11			// (at your option) any later version. //
12			// //
13			// You may not change or alter any portion of this comment or credits //
14			// of supporting developers from this source code or any supporting //
15			// source code which is considered copyrighted (c) material of the //
16			// original comment or credit authors. //
17			// //
18			// This program is distributed in the hope that it will be useful, //
19			// but WITHOUT ANY WARRANTY; without even the implied warranty of //
20			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
21			// GNU General Public License for more details. //
22			// //
23			// You should have received a copy of the GNU General Public License //
24			// along with this program; if not, write to the Free Software //
25			// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA //
26			// ------------------------------------------------------------------------ //
27
28			defined('XOOPS_ROOT_PATH') \|\| exit('XOOPS root path not defined');
29
30			/**
31			* Class XfguestbookMsg
32			*/
33			class XfguestbookMsg extends XoopsObject
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-14 00:00 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
34			{
35			// constructor
36			/**
37			* XfguestbookMsg constructor.
38			*/

XoopsModules25x / xfguestbook

Pull Request — master (#10)

XfguestbookMsg::__construct() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like