BenatEspina\StackExchangeApiClient\Model\Traits\CommentCountTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setCommentCount()	0	6	1
A	getCommentCount()	0	4	1
A	addComment()	0	6	1
A	removeComment()	0	6	1
A	getComments()	0	4	1
A	loadCommentCount()	0	8	2

<?php

/*
 * This file is part of the Stack Exchange Api Client library.
 *
 * Copyright (c) 2015 Beñat Espiña <benatespina@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace BenatEspina\StackExchangeApiClient\Model\Traits;

use BenatEspina\StackExchangeApiClient\Model\Comment;
use BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface;
use BenatEspina\StackExchangeApiClient\Util\Util;

/**
 * Class CommentCountTrait.
 *
 * @author Beñat Espiña <benatespina@gmail.com>
 */
trait CommentCountTrait
{
    /**
     * Number of comments.
     *
     * @var int
     */
    protected $commentCount;

    /**
     * An array of comments.
     *
     * @var array<\BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface>|null
     */
    protected $comments = [];

    /**
     * Sets number of comments.
     *
     * @param int $commentCount The number of comments
     *
     * @return $this self Object
     */
    public function setCommentCount($commentCount)
    {
        $this->commentCount = $commentCount;

        return $this;
    }

    /**
     * Gets number of comments.
     *
     * @return int
     */
    public function getCommentCount()
    {
        return $this->commentCount;
    }

    /**
     * Adds comment.
     *
     * @param \BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface|null $comment The comment object

Consider making the type for parameter $comment a bit more specific; maybe use CommentInterface.

     *
     * @return $this self Object
     */
    public function addComment(CommentInterface $comment)
    {
        $this->comments[] = $comment;

        return $this;
    }

    /**
     * Removes comment.
     *
     * @param \BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface|null $comment The comment object

Consider making the type for parameter $comment a bit more specific; maybe use CommentInterface.

     *
     * @return $this self Object
     */
    public function removeComment(CommentInterface $comment)
    {
        $this->comments = Util::removeElement($comment, $this->comments);

It seems like \BenatEspina\StackExchangeApiClient\Util\Util::removeElement($comment, $this->comments) of type array<integer,*> is incompatible with the declared type array<integer,object<BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface>>|null of property $comments.

        return $this;
    }

    /**
     * Gets array of comments.
     *
     * @return array<\BenatEspina\StackExchangeApiClient\Model\Interfaces\CommentInterface>|null
     */
    public function getComments()
    {
        return $this->comments;
    }

    /**
     * Loads the variables if the data exist into resource. It works like a constructor.
     *
     * @param null|mixed[] $resource The resource
     */
    protected function loadCommentCount($resource)
    {
        $this->commentCount = Util::setIfIntegerExists($resource, 'comment_count');
        $comments = Util::setIfArrayExists($resource, 'comments');
        foreach ($comments as $comment) {
            $this->comments[] = new Comment($comment);
        }
    }
}