Comments::actionList() - Code Metrics - Inspection of "Controller refactoring. Pack of fixes" - phpffcms/ffcms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 02a4a5...734a7e )

by Mihail

created 2016-07-18 12:13 UTC

Comments::actionList() B

↳ Parent: Comments

Complexity

Conditions	6
Paths	11

Size

Total Lines	60
Code Lines	31

Duplication

Lines	3
Ratio	5 %

Importance

Changes	7
Bugs	3	Features	0

Metric	Value
cc	6
eloc	31
c	7
b	3
f	0
nc	11
nop	1
dl	3
loc	60
rs	8.6961

How to fix Long Method

<?php

namespace Apps\Controller\Api;

use Apps\ActiveRecord\CommentPost;
use Apps\ActiveRecord\CommentAnswer;
use Apps\ActiveRecord\App as AppRecord;
use Apps\Model\Api\Comments\CommentAnswerAdd;
use Apps\Model\Api\Comments\CommentPostAdd;
use Apps\Model\Api\Comments\EntityCommentData;
use Extend\Core\Arch\ApiController;
use Ffcms\Core\App;
use Ffcms\Core\Helper\Type\Obj;
use Ffcms\Core\Helper\Type\Str;
use Ffcms\Core\Exception\NotFoundException;
use Ffcms\Core\Exception\NativeException;
use Ffcms\Core\Exception\ForbiddenException;

/**
 * Class Comments. View and add comments and answers via json based ajax query's
 * @package Apps\Controller\Api
 */
class Comments extends ApiController
{
    /**
     * Add comment or answer via ajax.
     * @return string
     * @throws NativeException
     */
    public function actionAdd()
    {
        $this->setJsonHeader();
        $configs = AppRecord::getConfigs('widget', 'Comments');

        $replayTo = (int)$this->request->request->get('replay-to');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $model = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        // check if its a answer (comment answer type)
        if ($replayTo > 0) {
            $model = new CommentAnswerAdd($configs);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $model->replayTo = $replayTo;
        } else { // sounds like new comment row
            $model = new CommentPostAdd($configs);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $model->pathway = App::$Security->strip_tags($this->request->request->get('pathway'));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        // pass general comment params to model
        $model->message = App::$Security->secureHtml((string)$this->request->request->get('message'));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $model->guestName = App::$Security->strip_tags($this->request->request->get('guest-name'));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        // check model conditions before add new row
        if ($model === null || !$model->check()) {
            throw new NativeException('Unknown error');
        }

        // add comment post or answer to database and get response active record row
        $record = $model->buildRecord();
        // pass row to entity builder model
        $response = new EntityCommentData($record);

        return json_encode([
            'status' => 1,
            'data' => $response->make() // build row to standard format
        ]);
    }

    /**
     * List comments as json object with defined offset index
     * @param int $index
     * @return string
     * @throws NotFoundException
     */
    public function actionList($index)
    {
        // set header
        $this->setJsonHeader();
        // get configs
        $configs = AppRecord::getConfigs('widget', 'Comments');
        // items per page
        $perPage = (int)$configs['perPage'];
        // offset can be only integer
        $index = (int)$index;
        $offset = $perPage * $index;
        // get comment target path and check
        $path = (string)$this->request->query->get('path');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (Str::likeEmpty($path)) {
            throw new NotFoundException('Wrong path');
        }

        // select comments from db and check it
        $query = CommentPost::where('pathway', '=', $path)
            ->where('moderate', '=', 0);

        // check if comments is depend of language locale
        if ((int)$configs['onlyLocale'] === 1) {

            $query = $query->where('lang', '=', $this->request->getLanguage());
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        // get comments with offset and limit
        $records = $query->skip($offset)
            ->take($perPage)
            ->get();

        // check if records is not empty
        if ($records->count() < 1) {
            throw new NotFoundException(__('There is no comments found yet. You can be the first!'));
        }

        // build output json data as array
        $data = [];
        foreach ($records as $comment) {
            // prepare specified data to output response, based on entity model
            $commentResponse = new EntityCommentData($comment);

            // build output json data
            $data[] = $commentResponse->make();
            $commentResponse = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }

        // calculate comments left count
        $count = CommentPost::where('pathway', '=', $path)->where('moderate', '=', 0)->count();
        $count -= $offset + $perPage;
        if ($count < 0) {
            $count = 0;
        }

        return json_encode([
            'status' => 1,
            'data' => $data,
            'leftCount' => $count
        ]);
    }

    /**
     * List answers by comment id as json object
     * @param int $commentId
     * @return string
     * @throws ForbiddenException
     * @throws NotFoundException
     */
    public function actionShowanswers($commentId)
    {
        $this->setJsonHeader();
        // check input data
        if (!Obj::isLikeInt($commentId) || (int)$commentId < 1) {
            throw new ForbiddenException('Input data is incorrect');
        }

        // get configs
        $configs = AppRecord::getConfigs('widget', 'Comments');

        // get data from db by comment id
        $records = CommentAnswer::where('comment_id', '=', $commentId)
            ->where('moderate', '=', 0);
        if ((int)$configs['onlyLocale'] === 1) {

            $records = $records->where('lang', '=', $this->request->getLanguage());
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        // check objects count
        if ($records->count() < 1) {
            throw new NotFoundException(__('No answers for comment is founded'));
        }

        // prepare output
        $response = [];
        foreach ($records->get() as $row) {
            $commentAnswer = new EntityCommentData($row);
            $response[] = $commentAnswer->make();
        }

        return json_encode([
            'status' => 1,
            'data' => $response
        ]);
    }

    /**
     * Get commentaries count for pathway. Pathway should be array [itemId => pathway]
     * @throws NativeException
     * @return string
     */
    public function actionCount()
    {
        // set headers
        $this->setJsonHeader();
        // get configs
        $configs = AppRecord::getConfigs('widget', 'Comments');
        // get path array from request
        $path = $this->request->query->get('path');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (!Obj::isArray($path) || count($path) < 1) {
            throw new NativeException('Wrong query params');
        }

        $count = [];
        // for each item in path array calculate comments count
        foreach ($path as $id => $uri) {
            $query = CommentPost::where('pathway', '=', $uri)->where('moderate', '=', 0);
            // check if comments is depend of language locale
            if ((int)$configs['onlyLocale'] === 1) {

                $query = $query->where('lang', '=', $this->request->getLanguage());
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }
            // set itemId => count
            $count[(int)$id] = $query->count();
        }
        // render json response
        return json_encode(['status' => 1, 'count' => $count]);
    }
}

1			<?php
2
3			namespace Apps\Controller\Api;
4
5			use Apps\ActiveRecord\CommentPost;
6			use Apps\ActiveRecord\CommentAnswer;
7			use Apps\ActiveRecord\App as AppRecord;
8			use Apps\Model\Api\Comments\CommentAnswerAdd;
9			use Apps\Model\Api\Comments\CommentPostAdd;
10			use Apps\Model\Api\Comments\EntityCommentData;
11			use Extend\Core\Arch\ApiController;
12			use Ffcms\Core\App;
13			use Ffcms\Core\Helper\Type\Obj;
14			use Ffcms\Core\Helper\Type\Str;
15			use Ffcms\Core\Exception\NotFoundException;
16			use Ffcms\Core\Exception\NativeException;
17			use Ffcms\Core\Exception\ForbiddenException;
18
19			/**
20			* Class Comments. View and add comments and answers via json based ajax query's
21			* @package Apps\Controller\Api
22			*/
23			class Comments extends ApiController
24			{
25			/**
26			* Add comment or answer via ajax.
27			* @return string
28			* @throws NativeException
29			*/
30			public function actionAdd()
31			{
32			$this->setJsonHeader();
33			$configs = AppRecord::getConfigs('widget', 'Comments');
34
35			$replayTo = (int)$this->request->request->get('replay-to');
			0 ignored issues – show Documentation introduced 2016-07-18 12:18 UTC by Report Bug Copy Issue Report The property `request` does not exist on `object<Apps\Controller\Api\Comments>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
36			$model = null;
			0 ignored issues – show Unused Code introduced 2016-02-03 08:54 UTC by Report Bug Copy Issue Report `$model` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
37			// check if its a answer (comment answer type)
38			if ($replayTo > 0) {

phpffcms / ffcms

Push — master ( 02a4a5...734a7e )

Comments::actionList() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like