XoopsComment

Complexity

Total Complexity

26

Size/Duplication

Total Lines	312
Duplicated Lines	0 %

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	com_status()	0	3	1
A	com_modid()	0	3	1
A	com_pid()	0	3	1
A	com_modified()	0	3	1
A	com_ip()	0	3	1
A	__construct()	0	28	1
A	com_uid()	0	3	1
A	com_url()	0	3	1
A	doxcode()	0	3	1
A	com_sig()	0	3	1
A	com_exparams()	0	3	1
A	com_created()	0	3	1
A	doimage()	0	3	1
A	com_user()	0	3	1
A	isRoot()	0	3	1
A	id()	0	3	1
A	com_rootid()	0	3	1
A	dobr()	0	3	1
A	com_id()	0	3	1
A	com_itemid()	0	3	1
A	com_text()	0	3	1
A	com_title()	0	3	1
A	dohtml()	0	3	1
A	com_icon()	0	3	1
A	dosmiley()	0	3	1
A	com_email()	0	3	1

<?php
/**
 * XOOPS Kernel Class
 *
 * 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 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @package             kernel
 * @since               2.0.0
 * @author              Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 */
defined('XOOPS_ROOT_PATH') || exit('Restricted access');

/**
 * A Comment
 *
 * @package             kernel
 *
 * @author              Kazumi Ono    <onokazu@xoops.org>
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 */
class XoopsComment extends XoopsObject
{
    //PHP 8.2 Dynamic properties deprecated
    public $com_id;
    public $com_pid;
    public $com_modid;
    public $com_icon;
    public $com_title;
    public $com_text;
    public $com_created;
    public $com_modified;
    public $com_uid;
    // Start Add by voltan
    public $com_user;
    public $com_email;
    public $com_url;
    // End Add by voltan
    public $com_ip;
    public $com_sig;
    public $com_itemid;
    public $com_rootid;
    public $com_status;
    public $com_exparams;
    public $dohtml;
    public $dosmiley;
    public $doxcode;
    public $doimage;
    public $dobr;

    /**
     * Constructor
     **/
    public function __construct()
    {
        parent::__construct();
        $this->initVar('com_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('com_pid', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_modid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('com_icon', XOBJ_DTYPE_OTHER, null, false);
        $this->initVar('com_title', XOBJ_DTYPE_TXTBOX, null, true, 255, true);

true of type true is incompatible with the type string expected by parameter $options of XoopsObject::initVar().

        $this->initVar('com_text', XOBJ_DTYPE_TXTAREA, null, true, null, true);
        $this->initVar('com_created', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_modified', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_uid', XOBJ_DTYPE_INT, 0, true);
        // Start added by voltan
        $this->initVar('com_user', XOBJ_DTYPE_TXTBOX, null, false, 60);
        $this->initVar('com_email', XOBJ_DTYPE_TXTBOX, null, false, 60);
        $this->initVar('com_url', XOBJ_DTYPE_TXTBOX, null, false, 60);
        // End added by voltan
        $this->initVar('com_ip', XOBJ_DTYPE_OTHER, null, false);
        $this->initVar('com_sig', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_itemid', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_rootid', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_status', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('com_exparams', XOBJ_DTYPE_OTHER, null, false, 255);
        $this->initVar('dohtml', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('dosmiley', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('doxcode', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('doimage', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('dobr', XOBJ_DTYPE_INT, 0, false);
    }

    /**
     * Returns Class Base Variable com_id
     * @param string $format
     * @return mixed
     */
    public function id($format = 'N')
    {
        return $this->getVar('com_id', $format);
    }

    /**
     * Returns Class Base Variable com_id
     * @param string $format
     * @return mixed
     */
    public function com_id($format = '')
    {
        return $this->getVar('com_id', $format);
    }

    /**
     * Returns Class Base Variable com_pid
     * @param string $format
     * @return mixed
     */
    public function com_pid($format = '')
    {
        return $this->getVar('com_pid', $format);
    }

    /**
     * Returns Class Base Variable com_modid
     * @param string $format
     * @return mixed
     */
    public function com_modid($format = '')
    {
        return $this->getVar('com_modid', $format);
    }

    /**
     * Returns Class Base Variable com_icon
     * @param string $format
     * @return mixed
     */
    public function com_icon($format = '')
    {
        return $this->getVar('com_icon', $format);
    }

    /**
     * Returns Class Base Variable bid
     * @param string $format
     * @return mixed
     */
    public function com_title($format = '')
    {
        return $this->getVar('com_title', $format);
    }

    /**
     * Returns Class Base Variable com_text
     * @param string $format
     * @return mixed
     */
    public function com_text($format = '')
    {
        return $this->getVar('com_text', $format);
    }

    /**
     * Returns Class Base Variable com_created
     * @param string $format
     * @return mixed
     */
    public function com_created($format = '')
    {
        return $this->getVar('com_created', $format);
    }

    /**
     * Returns Class Base Variable com_modified
     * @param string $format
     * @return mixed
     */
    public function com_modified($format = '')
    {
        return $this->getVar('com_modified', $format);
    }

    /**
     * Returns Class Base Variable com_uid
     * @param string $format
     * @return mixed
     */
    public function com_uid($format = '')
    {
        return $this->getVar('com_uid', $format);
    }

    // Start added by voltan
    /**
     * Returns Class Base Variable com_user
     * @param string $format
     * @return mixed
     */
    public function com_user($format = '')
    {
        return $this->getVar('com_user', $format);
    }

    /**
     * Returns Class Base Variable com_email
     * @param string $format
     * @return mixed
     */
    public function com_email($format = '')
    {
        return $this->getVar('com_email', $format);
    }

    /**
     * Returns Class Base Variable com_url
     * @param string $format
     * @return mixed
     */
    public function com_url($format = '')
    {
        return $this->getVar('com_url', $format);
    }
    // End added by voltan

    /**
     * Returns Class Base Variable com_ip
     * @param string $format
     * @return mixed
     */
    public function com_ip($format = '')
    {
        return $this->getVar('com_ip', $format);
    }

    /**
     * Returns Class Base Variable com_sig
     * @param string $format
     * @return mixed
     */
    public function com_sig($format = '')
    {
        return $this->getVar('com_sig', $format);
    }

    /**
     * Returns Class Base Variable com_itemid
     * @param string $format
     * @return mixed
     */
    public function com_itemid($format = '')
    {
        return $this->getVar('com_itemid', $format);
    }

    /**
     * Returns Class Base Variable com_rootid
     * @param string $format
     * @return mixed
     */
    public function com_rootid($format = '')
    {
        return $this->getVar('com_rootid', $format);
    }

    /**
     * Returns Class Base Variable com_status
     * @param string $format
     * @return mixed
     */
    public function com_status($format = '')
    {
        return $this->getVar('com_status', $format);
    }

    /**
     * Returns Class Base Variable com_exparams
     * @param string $format
     * @return mixed
     */
    public function com_exparams($format = '')
    {
        return $this->getVar('com_exparams', $format);
    }

    /**
     * Returns Class Base Variable bid
     * @param string $format
     * @return mixed
     */
    public function dohtml($format = '')
    {
        return $this->getVar('dohtml', $format);
    }

    /**
     * Returns Class Base Variable dosmiley
     * @param string $format
     * @return mixed
     */
    public function dosmiley($format = '')
    {
        return $this->getVar('dosmiley', $format);
    }

    /**
     * Returns Class Base Variable doxcode
     * @param string $format
     * @return mixed
     */
    public function doxcode($format = '')
    {
        return $this->getVar('doxcode', $format);
    }

    /**
     * Returns Class Base Variable doimage
     * @param string $format
     * @return mixed
     */
    public function doimage($format = '')
    {
        return $this->getVar('doimage', $format);
    }

    /**
     * Returns Class Base Variable dobr
     * @param string $format
     * @return mixed
     */
    public function dobr($format = '')
    {
        return $this->getVar('dobr', $format);
    }

    /**
     * Is this comment on the root level?
     *
     * @return bool
     */
    public function isRoot()
    {
        return ($this->getVar('com_id') == $this->getVar('com_rootid'));
    }
}

/**
 * XOOPS comment handler class.
 *
 * This class is responsible for providing data access mechanisms to the data source
 * of XOOPS comment class objects.
 *
 *
 * @package             kernel
 * @subpackage          comment
 *
 * @author              Kazumi Ono    <onokazu@xoops.org>
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 *
 * @todo Why is this not a XoopsPersistableObjectHandler?
 */
class XoopsCommentHandler extends XoopsObjectHandler
{
    /**
     * Create a {@link XoopsComment}
     *
     * @param bool $isNew Flag the object as "new"?
     *
     * @return XoopsComment
     */
    public function create($isNew = true)
    {
        $comment = new XoopsComment();
        if ($isNew) {
            $comment->setNew();
        }

        return $comment;
    }

    /**
     * Retrieve a {@link XoopsComment}
     *
     * @param int $id ID
     *
     * @return XoopsComment|false {@link XoopsComment}, false on fail
     **/
    public function get($id)
    {
        $comment = false;
        $id      = (int)$id;
        if ($id > 0) {
            $sql = 'SELECT * FROM ' . $this->db->prefix('xoopscomments') . ' WHERE com_id=' . $id;
            $result = $this->db->query($sql);

The method query() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

            if (!$this->db->isResultSet($result)) {
                return $comment;
            }
            $numrows = $this->db->getRowsNum($result);

The method getRowsNum() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

            if ($numrows == 1) {
                $comment = new XoopsComment();
                $comment->assignVars($this->db->fetchArray($result));

The method fetchArray() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

            }
        }

        return $comment;
    }

    /**
     * Write a comment to database
     *
     * @param XoopsObject|XoopsComment $comment a XoopsComment object
     *
     * @return bool true on success, otherwise false
     **/
    public function insert(XoopsObject $comment)
    {
        $className = 'XoopsComment';
        if (!($comment instanceof $className)) {
            return false;
        }
        if (!$comment->isDirty()) {
            return true;
        }
        if (!$comment->cleanVars()) {
            return false;
        }
        foreach ($comment->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        // Start edit by voltan
        if ($comment->isNew()) {
            $com_id = $this->db->genId('xoopscomments_com_id_seq');

The method genId() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

            $sql    = sprintf('INSERT INTO %s (com_id, com_pid, com_modid, com_icon, com_title, com_text, com_created, com_modified, com_uid, com_user, com_email, com_url, com_ip, com_sig, com_itemid, com_rootid, com_status, com_exparams, dohtml, dosmiley, doxcode, doimage, dobr) VALUES (%u, %u, %u, %s, %s, %s, %u, %u, %u, %s, %s, %s, %s, %u, %u, %u, %u, %s, %u, %u, %u, %u, %u)', $this->db->prefix('xoopscomments'), $com_id, $com_pid, $com_modid, $this->db->quoteString($com_icon), $this->db->quoteString($com_title), $this->db->quoteString($com_text), $com_created, $com_modified, $com_uid, $this->db->quoteString($com_user), $this->db->quoteString($com_email), $this->db->quoteString($com_url), $this->db->quoteString($com_ip), $com_sig, $com_itemid, $com_rootid, $com_status, $this->db->quoteString($com_exparams), $dohtml, $dosmiley, $doxcode, $doimage, $dobr);

The variable $com_sig does not exist. Did you maybe mean $com_id?

The variable $doxcode seems to be never defined.

The variable $com_text seems to be never defined.

The variable $com_pid does not exist. Did you maybe mean $com_id?

The variable $com_exparams seems to be never defined.

The variable $doimage seems to be never defined.

The variable $com_ip does not exist. Did you maybe mean $com_id?

The variable $com_uid does not exist. Did you maybe mean $com_id?

The variable $com_user seems to be never defined.

The variable $com_created seems to be never defined.

The variable $com_title seems to be never defined.

The variable $com_modid seems to be never defined.

The variable $dobr seems to be never defined.

The variable $com_status seems to be never defined.

The variable $com_rootid does not exist. Did you maybe mean $com_id?

The variable $dosmiley seems to be never defined.

The variable $com_url seems to be never defined.

The variable $com_icon does not exist. Did you maybe mean $com_id?

The variable $dohtml seems to be never defined.

The method quoteString() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

The variable $com_email seems to be never defined.

The variable $com_modified seems to be never defined.

The variable $com_itemid does not exist. Did you maybe mean $com_id?

        } else {
            $sql = sprintf('UPDATE %s SET com_pid = %u, com_icon = %s, com_title = %s, com_text = %s, com_created = %u, com_modified = %u, com_uid = %u, com_user = %s, com_email = %s, com_url = %s, com_ip = %s, com_sig = %u, com_itemid = %u, com_rootid = %u, com_status = %u, com_exparams = %s, dohtml = %u, dosmiley = %u, doxcode = %u, doimage = %u, dobr = %u WHERE com_id = %u', $this->db->prefix('xoopscomments'), $com_pid, $this->db->quoteString($com_icon), $this->db->quoteString($com_title), $this->db->quoteString($com_text), $com_created, $com_modified, $com_uid, $this->db->quoteString($com_user), $this->db->quoteString($com_email), $this->db->quoteString($com_url), $this->db->quoteString($com_ip), $com_sig, $com_itemid, $com_rootid, $com_status, $this->db->quoteString($com_exparams), $dohtml, $dosmiley, $doxcode, $doimage, $dobr, $com_id);

The variable $com_id seems to be never defined.

        }
        // End edit by voltan
        if (!$result = $this->db->query($sql)) {

The assignment to $result is dead and can be removed.

            return false;
        }
        if (empty($com_id)) {
            $com_id = $this->db->getInsertId();

The method getInsertId() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

        }
        $comment->assignVar('com_id', $com_id);

        return true;
    }

    /**
     * Delete a {@link XoopsComment} from the database
     *
     * @param XoopsObject|XoopsComment $comment a XoopsComment object
     *
     * @return bool true on success, otherwise false
     **/
    public function delete(XoopsObject $comment)
    {
        $className = 'XoopsComment';
        if (!($comment instanceof $className)) {
            return false;
        }
        $sql = sprintf('DELETE FROM %s WHERE com_id = %u', $this->db->prefix('xoopscomments'), $comment->getVar('com_id'));

It seems like $comment->getVar('com_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?

        if (!$result = $this->db->query($sql)) {

The assignment to $result is dead and can be removed.

            return false;
        }

        return true;
    }

    /**
     * Get some {@link XoopsComment}s
     *
     * @param CriteriaElement|CriteriaCompo $criteria
     * @param bool   $id_as_key Use IDs as keys into the array?
     *
     * @return array Array of {@link XoopsComment} objects
     **/
    public function getObjects(CriteriaElement $criteria = null, $id_as_key = false)
    {
        $ret   = array();
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('xoopscomments');
        if (isset($criteria) && \method_exists($criteria, 'renderWhere')) {
            $sql .= ' ' . $criteria->renderWhere();
            $sort = ($criteria->getSort() != '') ? $criteria->getSort() : 'com_id';
            $sql .= ' ORDER BY ' . $sort . ' ' . $criteria->getOrder();
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$this->db->isResultSet($result)) {
            return $ret;
        }
        /** @var array $myrow */
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $comment = new XoopsComment();
            $comment->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] =& $comment;
            } else {
                $ret[$myrow['com_id']] = &$comment;
            }
            unset($comment);
        }

        return $ret;
    }

    /**
     * Count Comments
     *
     * @param CriteriaElement|CriteriaCompo $criteria {@link CriteriaElement}
     *
     * @return int Count
     **/
    public function getCount(CriteriaElement $criteria = null)
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('xoopscomments');
        if (isset($criteria) && \method_exists($criteria, 'renderWhere')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        $result = $this->db->query($sql);
        if (!$this->db->isResultSet($result)) {
            return 0;
        }
        list($count) = $this->db->fetchRow($result);

The method fetchRow() does not exist on XoopsDatabase. Since it exists in all sub-types, consider adding an abstract or default implementation to XoopsDatabase.

        return (int)$count;
    }

    /**
     * Delete multiple comments
     *
     * @param CriteriaElement|CriteriaCompo $criteria {@link CriteriaElement}
     *
     * @return bool
     **/
    public function deleteAll(CriteriaElement $criteria = null)
    {
        $sql = 'DELETE FROM ' . $this->db->prefix('xoopscomments');
        if (isset($criteria) && \method_exists($criteria, 'renderWhere')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {

The assignment to $result is dead and can be removed.

            return false;
        }

        return true;
    }

    /**
     * Get a list of comments
     *
     * @param CriteriaElement $criteria {@link CriteriaElement}
     *
     * @return array Array of raw database records
     **/
    public function getList(CriteriaElement $criteria = null)
    {
        $comments = $this->getObjects($criteria, true);
        $ret      = array();
        foreach (array_keys($comments) as $i) {
            $ret[$i] = $comments[$i]->getVar('com_title');
        }

        return $ret;
    }

    /**
     * Retrieves comments for an item
     *
     * @param int    $module_id Module ID
     * @param int    $item_id   Item ID
     * @param string $order     Sort order
     * @param int    $status    Status of the comment
     * @param int    $limit     Max num of comments to retrieve
     * @param int    $start     Start offset
     *
     * @return array Array of {@link XoopsComment} objects
     **/
    public function getByItemId($module_id, $item_id, $order = null, $status = null, $limit = null, $start = 0)
    {
        $criteria = new CriteriaCompo(new Criteria('com_modid', (int)$module_id));
        $criteria->add(new Criteria('com_itemid', (int)$item_id));
        if (isset($status)) {
            $criteria->add(new Criteria('com_status', (int)$status));
        }
        if (isset($order)) {
            $criteria->setOrder($order);
        }
        if (isset($limit)) {
            $criteria->setLimit($limit);
            $criteria->setStart($start);
        }

        return $this->getObjects($criteria);
    }

    /**
     * Gets total number of comments for an item
     *
     * @param int $module_id Module ID
     * @param int $item_id   Item ID
     * @param int $status    Status of the comment
     *
     * @return array Array of {@link XoopsComment} objects
     **/
    public function getCountByItemId($module_id, $item_id, $status = null)
    {
        $criteria = new CriteriaCompo(new Criteria('com_modid', (int)$module_id));
        $criteria->add(new Criteria('com_itemid', (int)$item_id));
        if (isset($status)) {
            $criteria->add(new Criteria('com_status', (int)$status));
        }

        return $this->getCount($criteria);

The expression return $this->getCount($criteria) returns the type integer which is incompatible with the documented return type array.

    }

    /**
     * Get the top {@link XoopsComment}s
     *
     * @param int    $module_id
     * @param int    $item_id
     * @param string $order
     * @param int    $status
     *
     * @return array Array of {@link XoopsComment} objects
     **/
    public function getTopComments($module_id, $item_id, $order, $status = null)
    {
        $criteria = new CriteriaCompo(new Criteria('com_modid', (int)$module_id));
        $criteria->add(new Criteria('com_itemid', (int)$item_id));
        $criteria->add(new Criteria('com_pid', 0));
        if (isset($status)) {
            $criteria->add(new Criteria('com_status', (int)$status));
        }
        $criteria->setOrder($order);

        return $this->getObjects($criteria);
    }

    /**
     * Retrieve a whole thread
     *
     * @param int $comment_rootid
     * @param int $comment_id
     * @param int $status
     *
     * @return array Array of {@link XoopsComment} objects
     **/
    public function getThread($comment_rootid, $comment_id, $status = null)
    {
        $criteria = new CriteriaCompo(new Criteria('com_rootid', (int)$comment_rootid));
        $criteria->add(new Criteria('com_id', (int)$comment_id, '>='));
        if (isset($status)) {
            $criteria->add(new Criteria('com_status', (int)$status));
        }

        return $this->getObjects($criteria);
    }

    /**
     * Update
     *
     * @param XoopsComment $comment    {@link XoopsComment} object
     * @param string $field_name  Name of the field
     * @param mixed  $field_value Value to write
     *
     * @return bool
     **/
    public function updateByField(XoopsComment $comment, $field_name, $field_value)
    {
        $comment->unsetNew();
        $comment->setVar($field_name, $field_value);

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

    /**
     * Delete all comments for one whole module
     *
     * @param  int $module_id ID of the module
     * @return bool
     **/
    public function deleteByModule($module_id)
    {
        return $this->deleteAll(new Criteria('com_modid', (int)$module_id));
    }
}