AbstractAdminGridController - Code Metrics - Inspection of "Rename list action to get" - atukai/AtAdmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 05caed...55eada )

by Alexander
created 2016-07-15 10:33 UTC
AbstractAdminGridController A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	266
Duplicated Lines	9.77 %
Coupling/Cohesion

Components	1
Dependencies	10
Importance

Changes	10
Bugs	0	Features	3
Metric	Value
wmc	25
c	10
b	0
f	3
lcom	1
cbo	10
dl	26
loc	266
rs	10
6 Methods

Rating	Name	Duplication	Size	Complexity
B	createAction()	13	57	5
C	editAction()	13	70	7
B	deleteAction()	0	33	4
A	setGridManager()	0	4	1
A	getGridManager()	0	8	2
B	getAction()	0	38	6
How to fix Duplicated Code

<?php

namespace AtAdmin\Controller;

use AtDataGrid\DataGrid;
use AtDataGrid\Form\FormBuilder;
use AtDataGrid\Manager as GridManager;
use Zend\EventManager\EventManager;
use Zend\Form\Form;
use Zend\View\Model\ViewModel;

abstract class AbstractAdminGridController extends AbstractAdminController
{
    // Events
    const EVENT_CHECK_PERMISSIONS_LIST   = 'at-admin.check-permissions.list';
    const EVENT_CHECK_PERMISSIONS_CREATE = 'at-admin.check-permissions.create';
    const EVENT_CHECK_PERMISSIONS_EDIT   = 'at-admin.check-permissions.edit';
    const EVENT_CHECK_PERMISSIONS_DELETE = 'at-admin.check-permissions.delete';

    const EVENT_VALIDATION_EDIT_PRE      = 'at-admin.validation.edit.pre';

    const EVENT_SAVE_PRE                 = 'at-admin.save.pre';
    const EVENT_SAVE_POST                = 'at-admin.save.post';
    const EVENT_DELETE_PRE               = 'at-admin.delete.pre';
    const EVENT_DELETE_POST              = 'at-admin.delete.post';

    const EVENT_SET_TEMPLATE_CREATE      = 'at-admin.set-template.create';
    const EVENT_SET_TEMPLATE_EDIT        = 'at-admin.set-template.edit';

    // Page titles
    // @todo Remove 
    const TITLE_ACTION_LIST              = '';
    const TITLE_ACTION_CREATE            = 'Create';
    const TITLE_ACTION_EDIT              = 'Edit';
    const TITLE_ACTION_DELETE            = 'Delete';

    /**
     * @var GridManager
     */
    protected $gridManager;

    /**
     * @return mixed
     */
    public function getAction()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->getEventManager()->trigger(self::EVENT_CHECK_PERMISSIONS_LIST, $this);

        // Save back url to redirect after actions
        $this->backTo()->setBackUrl();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        // Check for mass actions
        if (isset($_POST['cmd'])) {
            $this->forward($_POST['cmd']);    // @todo refactor this

        }

        $gridManager = $this->getGridManager();
        $grid = $gridManager->getGrid();

        if ($this->request->getQuery('order')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $order = explode('~', $this->request->getQuery('order'));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $grid->setOrder([$order[0] => $order[1]]);
        }

        if ($this->request->getQuery('page')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $grid->setCurrentPage($this->request->getQuery('page'));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        if ($this->request->getQuery('show_items')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $grid->setItemsPerPage($this->request->getQuery('show_items'));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        $filtersForm = $gridManager->getFiltersForm();
        $filtersForm->setData($this->request->getQuery());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        if (!$filtersForm->isValid()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //$this->flashMessenger()->addMessage($filtersForm->getMessages());

        }

        $grid->setFiltersData($filtersForm->getData());

        return $gridManager->render();
    }

    /**
     * @return mixed|ViewModel
     * @throws \Exception
     */
    public function createAction()
    {
        /** @var EventManager $eventManager */
        $eventManager = $this->getEventManager();

        $this->getEventManager()->trigger(self::EVENT_CHECK_PERMISSIONS_CREATE, $this);

        /** @var GridManager $gridManager */
        $gridManager = $this->getGridManager();
        if (! $gridManager->isAllowCreate()) {
            throw new \Exception('Creating is disabled');
        }

        /** @var FormBuilder $formManager */
        $formBuilder = $gridManager->getFormBuilder();

        /** @var DataGrid $grid */
        $grid = $gridManager->getGrid();

        /** @var Form $form */
        $form = $formBuilder->build($grid);

        if ($this->getRequest()->isPost()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $post = $this->getRequest()->getPost();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $form->setData($post);

            if ($form->isValid()) {

                // Replace POST data with filtered and validated form values
                // POST data may contains not only form data
                $data = array_replace($post->toArray(), $form->getData());

                $eventManager->trigger(self::EVENT_SAVE_PRE, null, $data);
                $item = $grid->save($data);
                $eventManager->trigger(self::EVENT_SAVE_POST, $item, $data);

                return $this->backTo()->previous('Record created');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            } else {
                $this->flashMessenger()->addMessage('Check form data.');
            }
        }

        $viewModel = new ViewModel([
            'title'        => static::TITLE_ACTION_CREATE,
            'form'         => $form,
            'customJs'     => $formBuilder->getCustomJs(),
            'formSections' => $formBuilder->getFormSections(),
            'backUrl'      => $this->backTo()->getBackUrl(false),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        ]);

        $viewModel->setTemplate('at-admin/create.phtml');
        $eventResult = $eventManager->trigger(self::EVENT_SET_TEMPLATE_CREATE, $viewModel)->last();
        if ($eventResult) {
            $viewModel = $eventResult;
        }

        return $viewModel;
    }

    /**
     * @return ViewModel
     * @throws \Exception
     */
    public function editAction()
    {
        /** @var Manager $gridManager */
        $gridManager = $this->getGridManager();

        /** @var DataGrid $grid */
        $grid = $gridManager->getGrid();

        if (!$gridManager->isAllowEdit()) {
            throw new \Exception('Editing is disabled');
        }

        $id = $this->params($grid->getIdentifierColumnName());
        if (!$id) {
            return $this->notFoundAction();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $item = $grid->getRow($id);
        if (!$item) {
            return $this->notFoundAction();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        /** @var EventManager $eventManager */
        $eventManager = $this->getEventManager();
        $eventManager->trigger(self::EVENT_CHECK_PERMISSIONS_EDIT, $item);

        /** @var FormBuilder $formBuilder */
        $formBuilder = $gridManager->getFormBuilder();

        /** @var Form $form */
        $form = $formBuilder->build($grid, FormBuilder::FORM_CONTEXT_EDIT, $item);

        if ($this->getRequest()->isPost()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $post = $this->getRequest()->getPost();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $form->setData($post);

            $this->getEventManager()->trigger(self::EVENT_VALIDATION_EDIT_PRE, $form, ['oldData' => $item, 'newData' => $post]);

            if ($form->isValid()) {

                // Replace POST data with filtered and validated form values
                // POST data may contains not only form data (extra data from sections)
                $data = array_replace($post->toArray(), $form->getData());

                $eventManager->trigger(self::EVENT_SAVE_PRE, $item, $data);
                $item = $grid->save($data, $id);
                $eventManager->trigger(self::EVENT_SAVE_POST, $item, $data);

                $this->backTo()->previous('Record was updated');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            } else {
                $this->flashMessenger()->addMessage('Check form data');
            }
        }

        $viewModel = new ViewModel([
            'title'        => static::TITLE_ACTION_EDIT,
            'item'         => $item,
            'form'         => $form,
            'customJs'     => $formBuilder->getCustomJs(),
            'formSections' => $formBuilder->getFormSections(),
            'backUrl'      => $this->backTo()->getBackUrl(false),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        ]);

        $viewModel->setTemplate('at-admin/edit.phtml');
        $eventResult = $this->getEventManager()->trigger(self::EVENT_SET_TEMPLATE_EDIT, $viewModel, ['item' => $item])->last();
        if ($eventResult) {
            $viewModel = $eventResult;
        }

        return $viewModel;
    }

    /**
     * @throws \Exception
     */
    public function deleteAction()
    {
        $gridManager = $this->getGridManager();
        if (!$gridManager->isAllowDelete()) {
            throw new \Exception('Deleting is disabled.');
        }

        $id = $this->params('id');
        if (!$id) {
            return $this->notFoundAction();
        }

        $grid = $gridManager->getGrid();
        $item = $grid->getRow($id);
        if (!$item) {
            return $this->notFoundAction();
        }

        $evm = $this->getEventManager();
        $evm->trigger(self::EVENT_CHECK_PERMISSIONS_DELETE, $item);

        // Get additional params
        $params = array_merge_recursive(
            $this->params()->fromQuery(),
            $this->params()->fromPost()
        );

        $evm->trigger(self::EVENT_DELETE_PRE, $item, $params);
        $grid->delete($id);
        $evm->trigger(self::EVENT_DELETE_POST, $item, $params);

        $this->backTo()->previous('Record deleted.');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * @param GridManager $manager
     */
    public function setGridManager(GridManager $manager)
    {
        $this->gridManager = $manager;
    }

    /**
     * @return Manager
     */
    public function getGridManager()
    {
        if (!$this->gridManager) {
            throw new \RuntimeException('GridManager is not set');
        }

        return $this->gridManager;
    }
}
Push — master ( 05caed...55eada )

AbstractAdminGridController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

atukai / AtAdmin

Push — master ( 05caed...55eada )

AbstractAdminGridController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
