UsersController - Code Metrics - Inspection of "Kmom04" - mosbth/Anax-MVC - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

unknown

created 2016-02-28 15:22 UTC

UsersController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	451
Duplicated Lines	31.04 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	5
Bugs	1	Features	2

Metric	Value
wmc	33
lcom	1
cbo	3
dl	140
loc	451
rs	9.3999
c	5
b	1
f	2

24 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	5	1
A	setupAction()	0	5	1
A	listAction()	10	10	1
A	acronymAction()	10	10	1
A	idAction()	9	9	1
A	add1Action()	0	21	2
A	addAction()	0	11	1
B	createAddUserForm()	0	30	1
B	callbackSubmitAddUser()	0	29	2
A	callbackSubmitFailAddUser()	0	5	1
A	callbackSuccess()	0	5	1
A	callbackFail()	0	5	1
A	updateAction()	19	19	2
B	createUpdateUserForm()	0	37	1
B	callbackSubmitUpdateUser()	0	32	2
A	callbackSubmitFailUpdateUser()	0	5	1
A	deleteAction()	0	10	2
A	softDeleteAction()	15	15	2
A	undoDeleteAction()	13	13	2
A	activateAction()	13	13	2
A	deactivateAction()	13	13	2
A	activeAction()	13	13	1
A	inactiveAction()	13	13	1
A	wastebasketAction()	12	12	1

How to fix Duplicated Code

<?php

namespace Anax\Users;

/**
 * A controller for users and admin related events.
 *
 */
class UsersController implements \Anax\DI\IInjectionAware
{
    use \Anax\DI\TInjectable,
    \Anax\MVC\TRedirectHelpers;

    /**
     * Initialize the controller.
     *
     * @return void
     */
    public function initialize()
    {
        $this->users = new \Anax\Users\User();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->users->setDI($this->di);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Setup initial table for users.
     *
     * @return void
     */
    public function setupAction()
    {
        $this->users->init();
        $this->redirectTo('users/list/');
    }
    /**
     * List all users.
     *
     * @return void
     */
    public function listAction()

    {
        $all = $this->users->findAll();

        $this->theme->setTitle("List all users");
<?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.");
        }
    }

}
        $this->views->add('users/list-all', [
<?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.");
        }
    }

}
            'users' => $all,
            'title' => "View all users",
        ]);
    }
    /**
     * List user with acronym.
     *
     * @param int $id of user to display
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return void
     */
    public function acronymAction($acronym = null)

    {
        $user = $this->users->query()
        ->where('acronym = ' . "'$acronym'")
        ->execute()[0];
        $this->theme->setTitle("View user with acronym");
<?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.");
        }
    }

}
        $this->views->add('users/view', [
<?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.");
        }
    }

}
            'user' => $user,
        ]);
    }
    /**
     * List user with id.
     *
     * @param int $id of user to display
     *
     * @return void
     */
    public function idAction($id = null)

    {
        $user = $this->users->find($id);

        $this->theme->setTitle("View user with id");
<?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.");
        }
    }

}
        $this->views->add('users/view', [
<?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.");
        }
    }

}
            'user' => $user,
        ]);
    }
    /**
     * Add new user.
     *
     * @param string $acronym of user to add.
     *
     * @return void
     */
    public function add1Action($acronym = null)
    {
        if (!isset($acronym)) {
            die("Missing acronym");
        }

        $now = gmdate('Y-m-d H:i:s');

        $this->users->save([
            'acronym' => $acronym,
            'email' => $acronym . '@mail.se',
            'name' => 'Mr/Mrs ' . $acronym,
            'password' => password_hash($acronym, PASSWORD_DEFAULT),
            'created' => $now,
            'active' => $now,
        ]);

        // $url = $this->url->create('users/id/' . $this->users->id);
        // $this->response->redirect($url);
        $this->redirectTo('users/id/' . $this->users->id);
    }
    /**
     * Add new user.
     *
     * @param string $acronym of user to add.
     *
     * @return void
     */
    public function addAction($acronym = null)

    {
        $this->di->session(); // Will load the session service which also starts the session
        $form = $this->createAddUserForm();
        $form->check([$this, 'callbackSuccess'], [$this, 'callbackFail']);
        $this->di->theme->setTitle("Add user");
        $this->di->views->add('default/page', [
            'title' => "Add user",
            'content' => $form->getHTML()
        ]);
    }
    private function createAddUserForm()
    {
        return $this->di->form->create([], [
            'name' => [
                'type'        => 'text',
                'label'       => 'Name of person:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'acronym' => [
                'type'        => 'text',
                'label'       => 'Acronym of person:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'email' => [
                'type'        => 'text',
                'required'    => true,
                'validation'  => ['not_empty', 'email_adress'],
            ],
            'submit' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitAddUser'],
            ],
            'submit-fail' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitFailAddUser'],
            ],
        ]);
    }
    /**
     * Callback for submit-button.
     *
     */
    public function callbackSubmitAddUser($form)
    {
        // $form->AddOutput("<p>DoSubmit(): Form was submitted.<p>");
        // $form->AddOutput("<p>Do stuff (save to database) and return true (success) or false (failed processing)</p>");
        $acronym = $form->Value('acronym');
        // Check for duplicate acronym. Die if exists.
        $all = $this->users->query()
            ->where("acronym = '$acronym'")
            ->execute();
        if (count($all)!=0) {
            die("User with acronym $acronym already in model.");
        }
        // Save user data to database
        $now = gmdate('Y-m-d H:i:s');
        $this->users->save([
            'acronym' => $form->Value('acronym'),
            'email' => $form->Value('email'),
            'name' => 'Mr/Mrs ' . $form->Value('name'),
            'password' => password_hash($acronym, PASSWORD_DEFAULT),
            'created' => $now,
            'active' => $now,
        ]);

        // $form->AddOutput("<p><b>Name: " . $form->Value('name') . "</b></p>");
        // $form->AddOutput("<p><b>Email: " . $form->Value('email') . "</b></p>");
        // $form->AddOutput("<p><b>Acronym: " . $form->Value('acronym') . "</b></p>");
        $form->saveInSession = false;
        return true;
    }
    /**
     * Callback for submit-button.
     *
     */
    public function callbackSubmitFailAddUser($form)
    {
        $form->AddOutput("<p><i>DoSubmitFail(): Form was submitted but I failed to process/save/validate it</i></p>");
        return false;
    }
    /**
     * Callback What to do if the form was submitted?
     *
     */
    public function callbackSuccess($form)
    {
        $form->AddOUtput("<p><i>Form was submitted and the callback method returned true.</i></p>");
        $this->redirectTo('users/id/' . $this->users->id);
    }
    /**
     * Callback What to do when form could not be processed?
     *
     */
    public function callbackFail($form)
    {
        $form->AddOutput("<p><i>Form was submitted and the Check() method returned false.</i></p>");
        $this->redirectTo();
    }


    /**
     * Update user.
     *
     * @param string $acronym of user to update.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return void
     */
    public function updateAction($id = null)

    {
        $this->di->session(); // Will load the session service which also starts the session
        // Check if valid entry exists.
        $all = $this->users->query()
            ->where("id = '$id'")
            ->execute();
        if (count($all)!=1) {
            die("User with id $id not found.");
        }
        $user = $this->users->find($id);
        $form = $this->createUpdateUserForm($user);
        $form->check([$this, 'callbackSuccess'], [$this, 'callbackFail']);
        $this->di->theme->setTitle("Update user");
        $this->di->views->add('default/page', [
            'title' => "Update user",
            'content' => $form->getHTML()
        ]);
    }
    private function createUpdateUserForm($user = null)
    {
        return $this->di->form->create([], [
            'name' => [
                'type'        => 'text',
                'value'       => $user->name,
                'label'       => 'Name of person:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'acronym' => [
                'type'        => 'text',
                'value'       => $user->acronym,
                'label'       => 'Acronym of person:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'email' => [
                'type'        => 'text',
                'value'       => $user->email,
                'required'    => true,
                'validation'  => ['not_empty', 'email_adress'],
            ],
            'id' => [
                'type'        => 'hidden',
                'value'       => $user->id,
            ],
            'submit' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitUpdateUser'],
            ],
            'submit-fail' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitFailUpdateUser'],
            ],
        ]);
    }
    public function callbackSubmitUpdateUser($form)
    {
        // $form->AddOutput("<p>DoSubmit(): Form was submitted.<p>");
        // $form->AddOutput("<p>Do stuff (save to database) and return true (success) or false (failed processing)</p>");
        // Handle update to duplicate acronym. Die if other user already has acronym.
        $id = $form->Value('id');
        $acronym = $form->Value('acronym');
        $all = $this->users->query()
            ->where("id != '$id'")
            ->andwhere("acronym = '$acronym'")
            ->execute();
        if (count($all)==1) {
            die("User with acronym $acronym alredy defined for other user. ");
        }
        // die();
        // Save user data to database
        $now = gmdate('Y-m-d H:i:s');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $this->users->save([
            'acronym' => $form->Value('acronym'),
            'email' => $form->Value('email'),
            'name' => 'Mr/Mrs ' . $form->Value('name'),
            // 'password' => password_hash($acronym, PASSWORD_DEFAULT),
            // 'created' => $now,
            // 'active' => $now,
        ]);

        // $form->AddOutput("<p><b>Name: " . $form->Value('name') . "</b></p>");
        // $form->AddOutput("<p><b>Email: " . $form->Value('email') . "</b></p>");
        // $form->AddOutput("<p><b>Phone: " . $form->Value('acronym') . "</b></p>");
        $form->saveInSession = false;
        return true;
    }
    /**
     * Callback for submit-button.
     *
     */
    public function callbackSubmitFailUpdateUser($form)
    {
        $form->AddOutput("<p><i>DoSubmitFail(): Form was submitted but I failed to process/save/validate it</i></p>");
        return false;
    }



    /**
     * Delete user.
     *
     * @param integer $id of user to delete.
     *
     * @return void
     */
    public function deleteAction($id = null)
    {
        if (!isset($id)) {
            die("Missing id");
        }

        $res = $this->users->delete($id);
$myVar = 'Value';
$higher = false;

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

        $this->redirectTo('users/list/');
    }
    /**
     * Delete (soft) user.
     *
     * @param integer $id of user to delete.
     *
     * @return void
     */
    public function softDeleteAction($id = null)

    {
        if (!isset($id)) {
            die("Missing id");
        }

        $now = gmdate('Y-m-d H:i:s');

        $user = $this->users->find($id);

        $user->deleted = $now;
        $user->save();

        $this->redirectTo('users/list/');
    }
    public function undoDeleteAction($id = null)

    {
        if (!isset($id)) {
            die("Missing id");
        }

        $user = $this->users->find($id);

        $user->deleted = null;
        $user->save();

        $this->redirectTo('users/id/' . $id);
    }
    public function activateAction($id = null)

    {
        if (!isset($id)) {
            die("Missing id");
        }

        $user = $this->users->find($id);

        $user->active = gmdate('Y-m-d H:i:s');
        $user->save();

        $this->redirectTo('users/id/' . $id);
    }
    public function deactivateAction($id = null)

    {
        if (!isset($id)) {
            die("Missing id");
        }

        $user = $this->users->find($id);

        $user->active = null;
        $user->save();

        $this->redirectTo('users/id/' . $id);
    }
    /**
     * List all active and not deleted users.
     *
     * @return void
     */
    public function activeAction()

    {
        $all = $this->users->query()
            ->where('active IS NOT NULL')
            ->andWhere('deleted is NULL')
            ->execute();

        $this->theme->setTitle("Users that are active");
<?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.");
        }
    }

}
        $this->views->add('users/list-all', [
<?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.");
        }
    }

}
            'users' => $all,
            'title' => "Users that are active",
        ]);
    }
    /**
     * List all inactive and not deleted users.
     *
     * @return void
     */
    public function inactiveAction()

    {
        $all = $this->users->query()
            ->where('active IS NULL')
            ->andWhere('deleted is NULL')
            ->execute();

        $this->theme->setTitle("Users that are inactive");
<?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.");
        }
    }

}
        $this->views->add('users/list-all', [
<?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.");
        }
    }

}
            'users' => $all,
            'title' => "Users that are inactive",
        ]);
    }
    /**
     * List all active and not deleted users.
     *
     * @return void
     */
    public function wastebasketAction()

    {
        $all = $this->users->query()
            ->where('deleted is NOT NULL')
            ->execute();

        $this->theme->setTitle("Users that are in wastebasket");
<?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.");
        }
    }

}
        $this->views->add('users/list-all', [
<?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.");
        }
    }

}
            'users' => $all,
            'title' => "Users that are in wastebasket",
        ]);
    }
}


1			<?php
2
3			namespace Anax\Users;
4
5			/**
6			* A controller for users and admin related events.
7			*
8			*/
9			class UsersController implements \Anax\DI\IInjectionAware
10			{
11			use \Anax\DI\TInjectable,
12			\Anax\MVC\TRedirectHelpers;
13
14			/**
15			* Initialize the controller.
16			*
17			* @return void
18			*/
19			public function initialize()
20			{
21			$this->users = new \Anax\Users\User();
			0 ignored issues – show Bug introduced 2016-02-28 15:25 UTC by Report Bug Copy Issue Report The property `users` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
22			$this->users->setDI($this->di);
			0 ignored issues – show Bug introduced 2016-02-28 15:25 UTC by Report Bug Copy Issue Report It seems like `$this->di` can also be of type `array` or `null`; however, `Anax\DI\TInjectable::setDI()` does only seem to accept `object<Anax\DI\class>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
23			}
24
25			/**
26			* Setup initial table for users.
27			*
28			* @return void
29			*/
30			public function setupAction()
31			{
32			$this->users->init();
33			$this->redirectTo('users/list/');
34			}
35			/**
36			* List all users.
37			*
38			* @return void

mosbth / Anax-MVC

Pull Request — master (#18)

UsersController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

24 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like