Anax\CommentDb\CommentController

Complexity

Total Complexity

17

Size/Duplication

Total Lines	291
Duplicated Lines	13.4 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	10
Bugs	3	Features	4

15 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	5	1
A	setupAction()	0	5	1
A	listAction()	11	11	1
A	viewAction()	10	10	1
A	addAction()	0	15	1
B	createAddCommentForm()	0	41	1
A	callbackSubmitAddComment()	0	20	1
A	callbackSubmitFailAddComment()	0	6	1
A	callbackSuccess()	0	6	1
A	callbackFail()	0	6	1
A	editAction()	18	18	2
B	createEditCommentForm()	0	45	1
A	callbackSubmitUpdateComment()	0	17	1
A	callbackSubmitFailUpdateComment()	0	5	1
A	deleteAction()	0	10	2

<?php
/**
 * class for commenting
 */
namespace Anax\CommentDb;

class CommentController implements \Anax\DI\IInjectionAware
{
    use \Anax\DI\TInjectable,
    \Anax\MVC\TRedirectHelpers;

    /**
     * Initialize the controller.
     *
     * @return void
     */
    public function initialize()
    {
        $this->comments = new \Anax\CommentDb\CommentsInDb();

The property comments does not exist. Did you maybe forget to declare it?

        $this->comments->setDI($this->di);

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?

    }

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

This method seems to be duplicated in your project.

    {
        $all = $this->comments->findAll();
        $flow = $this->request->getRoute();

The property request does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

        $link = $this->url->create('comment/add/' . $flow);

The property url does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->theme->setTitle("List all users");

The property theme does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->views->add('comment/commentsdb', [

The property views does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

            'comments' => $all,
            'comment_link' => $link,
        ]);
    }
    /**
     * View all comments in page flow.
     *
     * @return void
     */
    public function viewAction()

This method seems to be duplicated in your project.

    {
        $flow = $this->request->getRoute();

The property request does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

        $all = $this->comments->findFlow($flow);
        $link = $this->url->create('comment/add/' . $flow);

The property url does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->views->add('comment/commentsdb', [

The property views does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

            'comments' => $all,
            'comment_link' => $link,
        ]);
    }

    /**
     * Add new comment.
     *
     * @param string $route to page for comment flow.
     *
     * @return void
     */
    public function addAction($route = null)

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

    {
        // Route parts are are in argument array. Glue them together again.
        $route = implode("/", func_get_args());
        // TODO: Need to sweep session? How?
        // Set saveInSession = false instead.
        $this->di->session(); // Will load the session service which also starts the session
        $form = $this->createAddCommentForm($route);
        $form->check([$this, 'callbackSuccess'], [$this, 'callbackFail']);
        $this->di->theme->setTitle("Add user");
        $this->di->views->add('default/page', [
            'title' => "Add Comment",
            'content' => $form->getHTML()
        ]);
    }
    private function createAddCommentForm($route)
    {
        return $this->di->form->create([], [
            'content' => [
                'type'        => 'textarea',
                'label'       => 'Comment:',
                'required'    => false,
                // 'validation'  => ['not_empty'],
            ],
            'name' => [
                'type'        => 'text',
                'label'       => 'Name:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'web' => [
                'type'        => 'text',
                'label'       => 'Homepage:',
                'required'    => false,
                // 'validation'  => ['not_empty'],
            ],
            'mail' => [
                'type'        => 'text',
                'required'    => true,
                'label'       => 'Email:',
                'validation'  => ['not_empty', 'email_adress'],
            ],
            'flow' => [
                'type'        => 'hidden',
                'value'       => $route,
            ],
            'submit' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitAddComment'],
            ],
            'submit-fail' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitFailAddComment'],
            ],
        ]);
    }
    /**
     * Callback for submit-button.
     *
     */
    public function callbackSubmitAddComment($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>");
        // Save comment to database
        $now = time();
        $this->comments->save([
            'flow' => $form->Value('flow'),
            'content' => $form->Value('content'),
            'name' => $form->Value('name'),
            'web' => $form->Value('web'),
            'mail' => $form->Value('mail'),
            'created' => $now,
        ]);

        // $form->AddOutput("<p><b>Name: " . $form->Value('name') . "</b></p>");
        // $form->AddOutput("<p><b>Email: " . $form->Value('mail') . "</b></p>");
        $form->saveInSession = false;
        return true;
    }
    /**
     * Callback for submit-button.
     *
     */
    public function callbackSubmitFailAddComment($form)
    {
        // TODO: Remove this?
        $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>");
        // Redirect to page posted from.
        $this->redirectTo($form->Value('flow'));
    }
    /**
     * 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>");
        // Redirect to comment form.
        $this->redirectTo();
    }

    /**
     * Edit comment.
     *
     * @param string $acronym of user to update.

There is no parameter named $acronym. Was it maybe removed?

     *
     * @return void
     */
    public function editAction($id = null)

This method seems to be duplicated in your project.

    {
        $this->di->session(); // Will load the session service which also starts the session
        $all = $this->comments->query()
            ->where("id = '$id'")
            ->execute();
        if (count($all)!=1) {
            die("Comment with id $id not found.");
        }
        $comment = $this->comments->find($id);
        $form = $this->createEditCommentForm($comment);
        $form->check([$this, 'callbackSuccess'], [$this, 'callbackFail']);
        $this->di->theme->setTitle("Edit comment");
        $this->di->views->add('default/page', [
            'title' => "Edit comment",
            'content' => $form->getHTML()
        ]);
    }
    private function createEditCommentForm($comment = null)
    {
        return $this->di->form->create([], [
            'content' => [
                'type'        => 'textarea',
                'value'       => $comment->content,
                'label'       => 'Comment:',
                'required'    => false,
                // 'validation'  => ['not_empty'],
            ],
            'name' => [
                'type'        => 'text',
                'value'       => $comment->name,
                'label'       => 'Name of person:',
                'required'    => true,
                'validation'  => ['not_empty'],
            ],
            'web' => [
                'type'        => 'text',
                'value'       => $comment->web,
                'label'       => 'Homepage:',
                'required'    => false,
                // 'validation'  => ['not_empty'],
            ],
            'mail' => [
                'type'        => 'text',
                'value'       => $comment->mail,
                'required'    => true,
                'label'       => 'Email:',
                'validation'  => ['not_empty', 'email_adress'],
            ],
            'flow' => [
                'type'        => 'hidden',
                'value'       => $comment->flow,
            ],
            'submit' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitUpdateComment'],
            ],
            'submit-fail' => [
                'type'      => 'submit',
                'callback'  => [$this, 'callbackSubmitFailUpdateComment'],
            ],
        ]);
    }
    public function callbackSubmitUpdateComment($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>");
        // Save user data to database
        $this->comments->save([
            'content' => $form->Value('content'),
            'name' => $form->Value('name'),
            'web' => $form->Value('web'),
            'mail' => $form->Value('mail'),
        ]);

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



    /**
     * Delete a comment.
     *
     * @return void
     */
    public function deleteAction()
    {
        $id = $this->request->getGet('id');

The property request does not exist on object<Anax\CommentDb\CommentController>. Since you implemented __get, maybe consider adding a @property annotation.

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

        $res = $this->comments->delete($id);

$res is not used, you could remove the assignment.

        $this->redirectTo($_SERVER['HTTP_REFERER']);
    }
}