DraftsController::add() - Code Metrics - Inspection of "Save drafts on composing a posting #342" - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — feature/Save_drafts_on_composi... (9c2717)

by Schlaefer

created 2019-08-28 17:47 UTC

DraftsController::add() A

↳ Parent: DraftsController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	25
rs	9.52
c	0
b	0
f	0

<?php

declare(strict_types=1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace App\Controller;

use Api\Controller\ApiAppController;
use App\Model\Table\DraftsTable;
use Cake\Http\Exception\BadRequestException;
use Cake\Http\Exception\NotFoundException;
use Saito\Exception\SaitoForbiddenException;

/**
 * Endpoint for adding/POST and editing/PUT posting
 *
 * @property DraftsTable $Drafts
 */
class DraftsController extends ApiAppController
{
    /**
     * Adds a new draft
     *
     * @return void
     */
    public function add(): void
    {
        $data = $this->getRequest()->getData();
        $data['user_id'] = $this->CurrentUser->getId();
        $draft = $this->Drafts->newEntity(
            $data,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            ['fields' => ['pid', 'subject', 'text', 'user_id']]
        );

        $draft = $this->Drafts->save($draft);

        if (!$draft) {
            throw new BadRequestException();
        }

        $response = [
            'type' => 'drafts',
            'id' => $draft->get('id'),
            'attributes' => [
                'id' => $draft->get('id'),
            ]
        ];
        $this->set('data', $response);
        $this->set('_serialize', ['data']);
    }

    /**
     * Updates an existing draft.
     *
     * @param string $id Id of the draft to be updated.
     * @return void
     */
    public function edit(string $id)
    {
        $id = (int)$id;
        try {
            $draft = $this->Drafts->get($id);
        } catch (\Throwable $e) {
            throw new NotFoundException(sprintf('Draft %s not found', $id));
        }

        if ($draft->get('user_id') !== $this->CurrentUser->getId()) {
            throw new SaitoForbiddenException(
                sprintf('Attempt to access draft %s.', $id),
                ['CurrentUser' => $this->CurrentUser]
            );
        }

        $data = $this->getRequest()->getData();
        if (empty($data['text']) && empty($data['subject'])) {
            /// Don't keep empty drafts. Empty data deletes the draft.
            $this->Drafts->delete($draft);

            // Clear out the draft-id in the frontend, so a potential restarted
            // draft is going to trigger an add() in the frontend which starts a
            // new draft.
            $response = [
                'type' => 'drafts',
                'id' => null,
                'attributes' => [
                    'id' => null,
                ]
            ];
            $this->set('data', $response);
        } else {
            $this->Drafts->patchEntity(
                $draft,
                $data,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                ['fields' => ['subject', 'text']]
            );
            $this->Drafts->save($draft);
            $this->set('data', []);
        }
        $this->set('_serialize', ['data']);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Saito - The Threaded Web Forum
7			*
8			* @copyright Copyright (c) the Saito Project Developers
9			* @link https://github.com/Schlaefer/Saito
10			* @license http://opensource.org/licenses/MIT
11			*/
12
13			namespace App\Controller;
14
15			use Api\Controller\ApiAppController;
16			use App\Model\Table\DraftsTable;
17			use Cake\Http\Exception\BadRequestException;
18			use Cake\Http\Exception\NotFoundException;
19			use Saito\Exception\SaitoForbiddenException;
20
21			/**
22			* Endpoint for adding/POST and editing/PUT posting
23			*
24			* @property DraftsTable $Drafts
25			*/
26			class DraftsController extends ApiAppController
27			{
28			/**
29			* Adds a new draft
30			*
31			* @return void
32			*/
33			public function add(): void
34			{
35			$data = $this->getRequest()->getData();
36			$data['user_id'] = $this->CurrentUser->getId();
37			$draft = $this->Drafts->newEntity(
38			$data,
			1 ignored issue – show Bug introduced 2019-08-28 17:50 UTC by Report Bug Copy Issue Report It seems like `$data` defined by `$this->getRequest()->getData()` on line `35` can also be of type `string`; however, `Cake\ORM\Table::newEntity()` does only seem to accept `array\|null`, 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...
39			['fields' => ['pid', 'subject', 'text', 'user_id']]
40			);
41
42			$draft = $this->Drafts->save($draft);
43
44			if (!$draft) {
45			throw new BadRequestException();
46			}
47
48			$response = [
49			'type' => 'drafts',
50			'id' => $draft->get('id'),
51			'attributes' => [
52			'id' => $draft->get('id'),
53			]
54			];
55			$this->set('data', $response);
56			$this->set('_serialize', ['data']);
57			}
58
59			/**
60			* Updates an existing draft.
61			*
62			* @param string $id Id of the draft to be updated.
63			* @return void
64			*/
65			public function edit(string $id)
66			{
67			$id = (int)$id;
68			try {
69			$draft = $this->Drafts->get($id);
70			} catch (\Throwable $e) {
71			throw new NotFoundException(sprintf('Draft %s not found', $id));
72			}
73
74			if ($draft->get('user_id') !== $this->CurrentUser->getId()) {
75			throw new SaitoForbiddenException(
76			sprintf('Attempt to access draft %s.', $id),
77			['CurrentUser' => $this->CurrentUser]
78			);
79			}
80
81			$data = $this->getRequest()->getData();
82			if (empty($data['text']) && empty($data['subject'])) {
83			/// Don't keep empty drafts. Empty data deletes the draft.
84			$this->Drafts->delete($draft);
85
86			// Clear out the draft-id in the frontend, so a potential restarted
87			// draft is going to trigger an add() in the frontend which starts a
88			// new draft.
89			$response = [
90			'type' => 'drafts',
91			'id' => null,
92			'attributes' => [
93			'id' => null,
94			]
95			];
96			$this->set('data', $response);
97			} else {
98			$this->Drafts->patchEntity(
99			$draft,
100			$data,
			0 ignored issues – show Bug introduced 2019-08-28 17:50 UTC by Report Bug Copy Issue Report It seems like `$data` defined by `$this->getRequest()->getData()` on line `81` can also be of type `string`; however, `Cake\ORM\Table::patchEntity()` does only seem to accept `array`, 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...
101			['fields' => ['subject', 'text']]
102			);
103			$this->Drafts->save($draft);
104			$this->set('data', []);
105			}
106			$this->set('_serialize', ['data']);
107			}
108			}
109

Schlaefer / Saito

Branch — feature/Save_drafts_on_composi... (9c2717)

DraftsController::add() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like