Pamo\User\UserController

Complexity

Total Complexity

16

Size/Duplication

Total Lines	320
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	invalidAction()	0	8	1
A	createAction()	0	15	1
A	dumpDiActionGet()	0	5	1
A	indexActionGet()	0	10	1
A	activityAction()	0	23	1
A	updateAction()	0	21	2
A	catchAll()	0	5	1
A	logoutAction()	0	5	1
A	profileAction()	0	15	2
A	deleteAction()	0	21	2
A	loginAction()	0	15	1
A	ineligibleAction()	0	8	1
A	initialize()	0	7	1

<?php

namespace Pamo\User;

use Anax\Commons\ContainerInjectableInterface;
use Anax\Commons\ContainerInjectableTrait;
use Pamo\User\HTMLForm\UserLoginForm;

/**
 * User controller.
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class UserController implements ContainerInjectableInterface
{
    use ContainerInjectableTrait;



    /**
     * The initialize method is optional and will always be called before the
     * target method/action. This is a convienient method where you could
     * setup internal properties that are commonly used by several methods.
     *
     * @return void
     */
    public function initialize() : void
    {
        $this->base = "user";

The property base does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->title = "Users";

The property title does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->game = $this->di->get("game");

The property game does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->page = $this->di->get("page");

The property page does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->page->add("block/nav-admin", $this->game->getNav());
    }



    /**
     * Description.
     *
     * @param datatype $variable Description

The type Pamo\User\datatype was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws Exception
     *
     * @return object as a response object
     */
    public function indexActionGet() : object
    {
        $this->page->add($this->base . "/crud/view-all", [
            "title" => "All Users",
            "users" => $this->game->user->findAll(),
            "gravatar" => $this->game->gravatar
        ]);

        return $this->page->render([
            "title" => $this->title,
        ]);
    }



    /**
     * Description.
     *
     * @param string $username of user
     *
     *
     * @return object as a response object
     */
    public function invalidAction() : object
    {
        $this->page->add($this->base . "/invalid", [
            "title" => "Invalid user"
        ]);

        return $this->page->render([
            "title" => $this->title,
        ]);
    }



    /**
     * Description.
     *
     * @param string $username of user
     *
     *
     * @return object as a response object
     */
    public function ineligibleAction() : object
    {
        $this->page->add($this->base . "/ineligible", [
            "title" => "Ineligible"
        ]);

        return $this->page->render([
            "title" => $this->title,
        ]);
    }



    /**
     * Description.
     *
     * @param string $username of user
     *
     *
     * @return object as a response object
     */
    public function profileAction() : object
    {
        if (!$this->game->activeUser()) {
            return $this->di->get("response")->redirect("user/login");
        }

        $username = $this->game->activeUser("username");

        $this->page->add($this->base . "/profile", [
            "title" => "Profile page for $username",
            "user" => $this->game->user->findWhere("username = ?", $username)
        ]);

        return $this->page->render([
            "title" => $this->title,
        ]);
    }



    /**
     * Description.
     *
     * @param string $username of user
     *
     *
     * @return object as a response object
     */
    public function activityAction($username) : object
    {
        $select1 = "*, CommentQuestion.id AS commentid, CommentQuestion.text AS comment, CommentQuestion.created AS commentdate, CommentQuestion.user AS commentuser";
        $select2 = "*, CommentAnswer.id AS commentid, CommentAnswer.text AS comment, CommentAnswer.created AS commentdate, CommentAnswer.user AS commentuser";

        $data = [
            "title" => "Activity page for $username",
            "user" => $this->game->user->findWhere("username = ?", $username),
            "questions" => $this->game->question->findAllWhere("user = ?", $username),
            "answers" => $this->game->answer->findAllWhere("user = ?", $username),
            "commentQuestions" => $this->game->commentQuestion->joinWhere("CommentQuestion.user = ?", $username, "Question", "Question.id = CommentQuestion.questionid", $select1),
            "commentAnswers" => $this->game->commentAnswer->joinWhere("CommentAnswer.user = ?", $username, "Answer", "Answer.id = CommentAnswer.answerid", $select2),
            "gravatar" => $this->game->gravatar
        ];

        $this->page->add($this->base . "/activity/header", $data);
        $this->page->add($this->base . "/activity/questions", $data);
        $this->page->add($this->base . "/activity/answers", $data);
        $this->page->add($this->base . "/activity/question-comments", $data);
        $this->page->add($this->base . "/activity/answer-comments", $data);

        return $this->page->render([
            "title" => $this->title,
        ]);
    }



    /**
     * Description.
     *
     * @param datatype $variable Description
     *
     * @throws Exception
     *
     * @return object as a response object
     */
    public function loginAction() : object
    {
        $form = new UserLoginForm($this->di);
        $form->check();

        $this->page->add("block/header", [
            "title" => "Login",
        ]);

        $this->page->add("anax/v2/article/default", [
            "content" => $form->getHTML(),
        ]);

        return $this->page->render([
            "title" => "A login page",
        ]);
    }



    /**
     * Description.
     *
     * @param datatype $variable Description
     *
     * @throws Exception
     *
     * @return object as a response object
     */
    public function createAction() : object
    {
        $form = $this->game->getUserForm("create");
        $form->check();

        $this->page->add("block/header", [
            "title" => "Register",
        ]);

        $this->page->add("anax/v2/article/default", [
            "content" => $form->getHTML(),
        ]);

        return $this->page->render([
            "title" => "A create user page",
        ]);
    }



    /**
     * Description.
     *
     * @return object as a response object
     */
    public function updateAction() : object
    {
        if (!$this->game->activeUser()) {
            return $this->di->get("response")->redirect("user/login");
        }

        $username = $this->game->activeUser("username");

        $form = $this->game->getUserForm("edit", $username);
        $form->check();

        $this->page->add("block/header", [
            "title" => "Update Profile",
        ]);

        $this->page->add("anax/v2/article/default", [
            "content" => $form->getHTML(),
        ]);

        return $this->page->render([
            "title" => "Update profile",
        ]);
    }



    /**
     * Description.
     *
     * @return object as a response object
     */
    public function deleteAction() : object
    {
        if (!$this->game->activeUser()) {
            return $this->di->get("response")->redirect("user/login");
        }

        $username = $this->game->activeUser("username");

        $form = $this->game->getUserForm("delete", $username);
        $form->check();

        $this->page->add("block/header", [
            "title" => "Delete Account",
        ]);

        $this->page->add("anax/v2/article/default", [
            "content" => $form->getHTML(),
        ]);

        return $this->page->render([
            "title" => "Delete profile",
        ]);
    }



    /**
     * Description.
     *
     * @return null
     */
    public function logoutAction() : object
    {
        $this->di->get("session")->set("user", null);

        return $this->di->get("response")->redirect("user/login")->send();
    }

    /**
     * This sample method dumps the content of $di.
     * GET mountpoint/dump-app
     *
     * @return string
     */
    public function dumpDiActionGet() : string
    {
        // Deal with the action and return a response.
        $services = implode(", ", $this->di->getServices());
        return __METHOD__ . "<p>\$di contains: $services";
    }



    /**
     * Adding an optional catchAll() method will catch all actions sent to the
     * router. You can then reply with an actual response or return void to
     * allow for the router to move on to next handler.
     * A catchAll() handles the following, if a specific action method is not
     * created:
     * ANY METHOD mountpoint/**
     *
     * @param array $args as a variadic parameter.
     *
     * @return mixed
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function catchAll(...$args)

The parameter $args is not used and could be removed.

    {
        // Deal with the request and send an actual response, or not.
        //return __METHOD__ . ", \$db is {$this->db}, got '" . count($args) . "' arguments: " . implode(", ", $args);
        return;
    }
}