App\Controller\Admin\UsersController

Complexity

Total Complexity

16

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Test Coverage

Coverage

32.14%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	beforeFilter()	0	4	1
A	view()	0	7	1
A	edit()	0	15	3
A	logout()	0	3	1
A	delete()	0	10	2
A	index()	0	5	1
A	add()	0	13	3
A	login()	0	21	4

<?php

This file is missing a doc comment.

Filename "UsersController.php" doesn't match the expected filename "userscontroller.php"

The PHP open tag does not have a corresponding PHP close tag

Class found in ".php" file; use ".inc" extension instead

Missing file doc comment

namespace App\Controller\Admin;

use App\Controller\AppController;
use Cake\Event\EventInterface;

/**
 * Users Controller
 *
 * @property \App\Model\Table\UsersTable $Users
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UsersController extends AppController {

Opening brace of a class must be on the line after the definition

    public function beforeFilter(EventInterface $event) {

Opening brace should be on a new line

Missing function doc comment

Missing doc comment for function beforeFilter()

        parent::beforeFilter($event);
        //$this->Auth->allow('add','login','logout');

85% of this comment could be valid code. Did you maybe forget this after debugging?

No space found before comment text; expected "// $this->Auth->allow('add','login','logout');" but found "//$this->Auth->allow('add','login','logout');"

        $this->Authentication->addUnauthenticatedActions(['add','index','edit']);

Expected 1 space between comma and "'edit'"; 0 found

Expected one space after the comma, 0 found

Expected 1 space between comma and "'index'"; 0 found

    }

    /**
     * Index method
     *
     * @return \Cake\Network\Response|null

Function return type is not void, but function has no return statement

@return doc comment specified, but function has no return statement

     */
    public function index() {

Opening brace should be on a new line

        $users = $this->paginate($this->Users);

        $this->set(compact('users'));
        $this->set('_serialize', ['users']);
    }

    /**
     * View method
     *
     * @param string|null $id User id.

Parameter comment must be on the next line

     * @return \Cake\Network\Response|null

@return doc comment specified, but function has no return statement

Separate the @param and @return sections by a blank line.

Function return type is not void, but function has no return statement

     * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found.

Separate the @return and @throws sections by a blank line.

@throws comment must be on the next line

     */
    public function view($id = null) {

Opening brace should be on a new line

        $user = $this->Users->get($id, [
            'contain' => []

A comma should follow the last multiline array item. Found: ]

        ]);

        $this->set('user', $user);
        $this->set('_serialize', ['user']);
    }

    /**
     * Add method
     *
     * @return \Cake\Network\Response|null Redirects on successful add, renders view otherwise.
     */
    public function add() {

Opening brace should be on a new line

        $user = $this->Users->newEmptyEntity();
        if ($this->request->is('post')) {
            $user = $this->Users->patchEntity($user, $this->request->getData());
            if ($this->Users->save($user)) {
                $this->Flash->success(__('The user has been saved.'));

                return $this->redirect(['prefix' => 'Admin', 'controller' => 'Users', 'action' => 'index']);
            }

No blank line found after control structure

            $this->Flash->error(__('The user could not be saved. Please, try again.'));
        }

No blank line found after control structure

        $this->set(compact('user'));
        $this->set('_serialize', ['user']);
    }

    /**
     * Edit method
     *
     * @param string|null $id User id.

Parameter comment must be on the next line

     * @return \Cake\Network\Response|null Redirects on successful edit, renders view otherwise.

Separate the @param and @return sections by a blank line.

     * @throws \Cake\Network\Exception\NotFoundException When record not found.

@throws comment must be on the next line

Separate the @return and @throws sections by a blank line.

     */
    public function edit($id = null) {

Opening brace should be on a new line

        $user = $this->Users->get($id, [
            'contain' => []

A comma should follow the last multiline array item. Found: ]

        ]);
        if ($this->request->is(['patch', 'post', 'put'])) {
            $user = $this->Users->patchEntity($user, $this->getRequest()->getData());
            if ($this->Users->save($user)) {
                $this->Flash->success(__('The user has been saved.'));

                return $this->redirect(['prefix' => 'Admin', 'controller' => 'Users', 'action' => 'index']);
            }

No blank line found after control structure

            $this->Flash->error(__('The user could not be saved. Please, try again.'));
        }

No blank line found after control structure

        $this->set(compact('user'));
        $this->set('_serialize', ['user']);
    }

    /**
     * Delete method
     *
     * @param string|null $id User id.

Parameter comment must be on the next line

     * @return \Cake\Network\Response|null Redirects to index.

Separate the @param and @return sections by a blank line.

     * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found.

@throws comment must be on the next line

Separate the @return and @throws sections by a blank line.

     */
    public function delete($id = null) {

Opening brace should be on a new line

        $this->request->allowMethod(['post', 'delete']);
        $user = $this->Users->get($id);
        if ($this->Users->delete($user)) {
            $this->Flash->success(__('The user has been deleted.'));
        } else {

Expected newline after closing brace

            $this->Flash->error(__('The user could not be deleted. Please, try again.'));
        }

        return $this->redirect(['prefix' => 'Admin', 'controller' => 'Users', 'action' => 'index']);
    }

    public function login() {

Missing doc comment for function login()

Missing function doc comment

Opening brace should be on a new line

        /*

66% of this comment could be valid code. Did you maybe forget this after debugging?

          if ($this->request->is('post')) {

First line of comment not aligned correctly; expected 12 spaces but found 10

Block comments must start with a capital letter

          //$user = $this->Auth->identify();

Comment line indented incorrectly; expected at least 12 spaces but found 10

          $user = $this->Authentication->getResult();

Comment line indented incorrectly; expected at least 12 spaces but found 10

          $this->set('lu', $user);

Comment line indented incorrectly; expected at least 12 spaces but found 10

          if ($user) {

Comment line indented incorrectly; expected at least 12 spaces but found 10

          //$this->Auth->setUser($user);

Comment line indented incorrectly; expected at least 12 spaces but found 10

          return $this->redirect($this->Authentication->getLoginRedirect());

Comment line indented incorrectly; expected at least 12 spaces but found 10

          }

Comment line indented incorrectly; expected at least 12 spaces but found 10

          $this->Flash->error(__('Invalid username or password, try again'));

Comment line indented incorrectly; expected at least 12 spaces but found 10

          }

Comment line indented incorrectly; expected at least 12 spaces but found 10

         */

Last line of comment aligned incorrectly; expected 8 spaces but found 9

Empty line required after block comment

        $result = $this->Authentication->getResult();
        // If the user is logged in send them away.
        if ($result->isValid()) {
            $target = $this->Authentication->getLoginRedirect() ?? '/home';

Operation must be bracketed

            return $this->redirect($target);
        }

No blank line found after control structure

        if ($this->request->is('post') && !$result->isValid()) {

Expected 1 space(s) after NOT operator; 0 found

            $this->Flash->error('Invalid username or password');
        }
    }

    public function logout() {

Missing doc comment for function logout()

Missing function doc comment

Opening brace should be on a new line

        $this->Authentication->logout();
        return $this->redirect(['prefix' => 'Admin', 'controller' => 'Users', 'action' => 'login']);
    }

}