Comments::actionRead() - 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::actionRead() A

↳ Parent: Comments
Complexity

Conditions	3
Paths	2
Size

Total Lines	13
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
c	1
b	1
f	0
dl	0
loc	13
rs	9.4285
cc	3
eloc	6
nc	2
nop	1
<?php

namespace Apps\Controller\Admin;


use Apps\ActiveRecord\CommentAnswer;
use Apps\ActiveRecord\CommentPost;
use Apps\Model\Admin\Comments\FormSettings;
use Extend\Core\Arch\AdminController;
use Ffcms\Core\App;
use Ffcms\Core\Exception\NotFoundException;
use Ffcms\Core\Helper\HTML\SimplePagination;
use Ffcms\Core\Helper\Type\Arr;
use Apps\Model\Admin\Comments\FormCommentUpdate;
use Ffcms\Core\Helper\Type\Obj;
use Apps\Model\Admin\Comments\FormCommentDelete;
use Apps\Model\Admin\Comments\FormCommentModerate;

/**
 * Class Comments. Admin controller for management user comments.
 * This class provide general admin implementation of control for user comments and its settings.
 * @package Apps\Controller\Admin
 */
class Comments extends AdminController
{
    const VERSION = 0.1;
    const ITEM_PER_PAGE = 10;

    const TYPE_COMMENT = 'comment';
    const TYPE_ANSWER = 'answer';

    public $type = 'widget';

    /**
     * List user comments with pagination
     * @return string
     * @throws \Ffcms\Core\Exception\NativeException
     * @throws \Ffcms\Core\Exception\SyntaxException
     */
    public function actionIndex()

    {
        // set current page and offset
        $page = (int)$this->request->query->get('page');
<?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.");
        }
    }

}
        $offset = $page * self::ITEM_PER_PAGE;

        // initialize active record model
        $query = new CommentPost();

        // make pagination
        $pagination = new SimplePagination([
            'url' => ['comments/index'],
            'page' => $page,
            'step' => self::ITEM_PER_PAGE,
            'total' => $query->count()
        ]);

        // get result as active records object with offset
        $records = $query->orderBy('id', 'desc')->skip($offset)->take(self::ITEM_PER_PAGE)->get();

        // render output view
        return $this->view->render('index', [
<?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.");
        }
    }

}
            'records' => $records,
            'pagination' => $pagination
        ]);
    }

    /**
     * List comment - read comment and list answers
     * @param int $id
     * @return string
     * @throws \Ffcms\Core\Exception\NativeException
     * @throws NotFoundException
     * @throws \Ffcms\Core\Exception\SyntaxException
     */
    public function actionRead($id)
    {
        // find object in active record model
        $record = CommentPost::find($id);
        if ($record === null || $record === false) {
            throw new NotFoundException(__('Comment is not founded'));
        }

        // render response
        return $this->view->render('comment_read', [
<?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.");
        }
    }

}
            'record' => $record
        ]);
    }

    /**
     * Commentaries and answers edit action
     * @param string $type
     * @param int $id
     * @throws NotFoundException
     * @return string
     * @throws \Ffcms\Core\Exception\SyntaxException
     * @throws \Ffcms\Core\Exception\NativeException
     */
    public function actionEdit($type, $id)
    {
        // get active record by type and id from active records
        $record = null;
        switch ($type) {
            case static::TYPE_COMMENT:
                $record = CommentPost::find($id);
                break;
            case static::TYPE_ANSWER:
                $record = CommentAnswer::find($id);
                break;
        }

        // check if response is not empty
        if ($record === null || $record === false) {
            throw new NotFoundException(__('Comment is not founded'));
        }

        // init edit model
        $model = new FormCommentUpdate($record, $type);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // check if data is submited and validated
        if ($model->send() && $model->validate()) {
            $model->make();
            App::$Session->getFlashBag()->add('success', __('Comment or answer is successful updated'));
        }

        // render view
        return $this->view->render('edit', [
<?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' => $model->filter()
        ]);
    }

    /**
     * Delete comments and answers single or multiply items
     * @param string $type
     * @param int $id
     * @return string
     * @throws NotFoundException
     * @throws \Ffcms\Core\Exception\SyntaxException
     * @throws \Ffcms\Core\Exception\NativeException
     */
    public function actionDelete($type, $id = 0)
    {
        // sounds like a multiply delete definition
        if ($id === 0 || (int)$id < 1) {

            $ids = $this->request->query->get('selected');
<?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($ids) && Arr::onlyNumericValues($ids)) {
                $id = $ids;
            } else {
                throw new NotFoundException('Bad conditions');
            }
        } else {
            $id = [$id];
        }

        // prepare query to db
        $query = null;
        switch ($type) {
            case self::TYPE_COMMENT:
                $query = CommentPost::whereIn('id', $id);
                break;
            case self::TYPE_ANSWER:
                $query = CommentAnswer::whereIn('id', $id);
                break;
        }

        // check if result is not empty
        if ($query === null || $query->count() < 1) {

            throw new NotFoundException(__('No comments found for this condition'));
        }

        // initialize model
        $model = new FormCommentDelete($query, $type);

        // check if delete is submited
        if ($model->send() && $model->validate()) {

            $model->make();
            App::$Session->getFlashBag()->add('success', __('Comments or answers are successful deleted!'));
            $this->response->redirect('comments/' . ($type === 'answer' ? 'answerlist' : 'index'));

        }

        // render view
        return $this->view->render('delete', [
<?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' => $model
        ]);
    }

    /**
     * Moderate guest comments and answer - make it publish
     * @param string $type
     * @param int $id
     * @return string
     * @throws NotFoundException
     * @throws \Ffcms\Core\Exception\SyntaxException
     * @throws \Ffcms\Core\Exception\NativeException
     */
    public function actionPublish($type, $id = 0)
    {
        // check if it multiple accept ids
        if ($id === 0 || (int)$id < 1) {

            $ids = $this->request->query->get('selected');
<?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($ids) && Arr::onlyNumericValues($ids)) {
                $id = $ids;
            } else {
                throw new NotFoundException('Bad conditions');
            }
        } else {
            $id = [$id];
        }

        // build query
        $query = null;
        switch ($type) {
            case static::TYPE_COMMENT:
                $query = CommentPost::whereIn('id', $id)->where('moderate', '=', 1);
                break;
            case static::TYPE_ANSWER:
                $query = CommentAnswer::whereIn('id', $id)->where('moderate', '=', 1);
                break;
        }

        // check if result is not empty
        if ($query === null || $query->count() < 1) {

            throw new NotFoundException(__('No comments found for this condition'));
        }

        // initialize moderation model
        $model = new FormCommentModerate($query, $type);

        // check if form is submited
        if ($model->send()) {

            $model->make();
            App::$Session->getFlashBag()->add('success', __('Comments or answers are successful published'));
            $this->response->redirect('comments/' . ($type === 'answer' ? 'answerlist' : 'index'));

        }

        return $this->view->render('publish', [
<?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' => $model
        ]);
    }

    /**
     * List answers
     * @return string
     * @throws \Ffcms\Core\Exception\SyntaxException
     * @throws \Ffcms\Core\Exception\NativeException
     */
    public function actionAnswerlist()

    {
        // set current page and offset
        $page = (int)$this->request->query->get('page');
<?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.");
        }
    }

}
        $offset = $page * self::ITEM_PER_PAGE;

        // initialize ar answers model
        $query = new CommentAnswer();

        // build pagination list
        $pagination = new SimplePagination([
            'url' => ['comments/answerlist'],
            'page' => $page,
            'step' => self::ITEM_PER_PAGE,
            'total' => $query->count()
        ]);

        // get result as active records object with offset
        $records = $query->orderBy('id', 'desc')->skip($offset)->take(self::ITEM_PER_PAGE)->get();

        // render output view
        return $this->view->render('answer_list', [
<?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.");
        }
    }

}
            'records' => $records,
            'pagination' => $pagination
        ]);
    }

    /**
     * Comment widget global settings
     * @return string
     * @throws \Ffcms\Core\Exception\NativeException
     * @throws \Ffcms\Core\Exception\SyntaxException
     */
    public function actionSettings()

    {
        // initialize settings model
        $model = new FormSettings($this->getConfigs());

        // check if form is send
        if ($model->send()) {
            if ($model->validate()) {
                $this->setConfigs($model->getAllProperties());
                App::$Session->getFlashBag()->add('success', __('Settings is successful updated'));
                $this->response->redirect('comments/index');

            } else {
                App::$Session->getFlashBag()->add('error', __('Form validation is failed'));
            }
        }

        // render view
        return $this->view->render('settings', [
<?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' => $model->filter()
        ]);
    }




}
1		<?php
2
3		namespace Apps\Controller\Admin;
4
5
6		use Apps\ActiveRecord\CommentAnswer;
7		use Apps\ActiveRecord\CommentPost;
8		use Apps\Model\Admin\Comments\FormSettings;
9		use Extend\Core\Arch\AdminController;
10		use Ffcms\Core\App;
11		use Ffcms\Core\Exception\NotFoundException;
12		use Ffcms\Core\Helper\HTML\SimplePagination;
13		use Ffcms\Core\Helper\Type\Arr;
14		use Apps\Model\Admin\Comments\FormCommentUpdate;
15		use Ffcms\Core\Helper\Type\Obj;
16		use Apps\Model\Admin\Comments\FormCommentDelete;
17		use Apps\Model\Admin\Comments\FormCommentModerate;
18
19		/**
20		* Class Comments. Admin controller for management user comments.
21		* This class provide general admin implementation of control for user comments and its settings.
22		* @package Apps\Controller\Admin
23		*/
24		class Comments extends AdminController
25		{
26		const VERSION = 0.1;
27		const ITEM_PER_PAGE = 10;
28
29		const TYPE_COMMENT = 'comment';
30		const TYPE_ANSWER = 'answer';
31
32		public $type = 'widget';
33
34		/**
35		* List user comments with pagination
36		* @return string
37		* @throws \Ffcms\Core\Exception\NativeException
38		* @throws \Ffcms\Core\Exception\SyntaxException
39		*/
40	View Code Duplication	public function actionIndex()
phpffcms / ffcms

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

Comments::actionRead() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
