Convert::deleteSlaves() - Code Metrics - Inspection of "v2 fixes regarding delta attribute decorator" - gyselroth/balloon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dev (d5d70c)

by Raffael

created 2018-02-16 14:20 UTC

Convert::deleteSlaves() A

↳ Parent: Convert

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php

declare(strict_types=1);

/**
 * balloon
 *
 * @copyright   Copryright (c) 2012-2018 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Balloon\App\Convert\Api\v2;

use Balloon\App\Api\Controller;
use Balloon\App\Convert\Converter;
use Balloon\Filesystem;
use Balloon\Filesystem\Node\File;
use Balloon\Server;
use Micro\Http\Response;
use MongoDB\BSON\ObjectId;

class Convert extends Controller
{
    /**
     * Converter.
     *
     * @var Converter
     */
    protected $converter;

    /**
     * Filesystem.
     *
     * @var Filesystem
     */
    protected $fs;

    /**
     * Constructor.
     *
     * @param Converter $converter
     * @param Server    $server
     */
    public function __construct(Converter $converter, Server $server)
    {
        $this->fs = $server->getFilesystem();
        $this->converter = $converter;
    }

    /**
     * @api {get} /api/v2/files/:id/convert/supported-formats Get supported formats
     * @apiVersion 2.0.0
     * @apiName getSupportedFormats
     * @apiGroup App\Convert
     * @apiPermission none
     * @apiDescription Get supported file formats to convert to (formats do vary between files)
     * @apiUse _getNode
     *
     * @apiExample (cURL) exmaple:
     * curl -XGET "https://SERVER/api/v2/files/convert/supported-formats?id=544627ed3c58891f058b4686"
     *
     * @apiSuccess {string[]} - List of supported formats
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 200 OK
     * [
     *  "png",
     *  "jpg",
     *  "tiff"
     * ]
     *
     * @param string $id
     * @param string $p
     */
    public function getSupportedFormats(?string $id = null, ?string $p = null): Response
    {
        $file = $this->fs->getNode($id, $p, File::class);
        $result = $this->converter->getSupportedFormats($file);


        return (new Response())->setCode(200)->setBody($result);
    }

    /**
     * @api {get} /api/v2/files/:id/convert/slaves Get slaves
     * @apiVersion 2.0.0
     * @apiName getSlaves
     * @apiGroup App\Convert
     * @apiPermission none
     * @apiDescription Get existing conversion slaves
     * @apiUse _getNode
     *
     * @apiExample (cURL) exmaple:
     * curl -XGET "https://SERVER/api/v2/files/convert/slaves?id=544627ed3c58891f058b4686"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 200 OK
     * [
     * ]
     *
     * @param string $id
     * @param string $p
     */
    public function getSlaves(?string $id = null, ?string $p = null): Response
    {
        $file = $this->fs->getNode($id, $p, File::class);
        $body = [];

        foreach ($this->converter->getSlaves($file) as $slave) {

            $element = [
                'id' => (string) $slave['_id'],
                'master' => (string) $slave['master'],
                'format' => $slave['format'],
            ];

            if (isset($slave['slave'])) {
                $element['slave'] = (string) $slave['slave'];
            }

            $body[] = $element;
        }

        return (new Response())->setCode(200)->setBody($body);
    }

    /**
     * @api {post} /api/v2/files/:id/convert/slaves Add new slave
     * @apiVersion 2.0.0
     * @apiName postSlaves
     * @apiGroup App\Convert
     * @apiPermission none
     * @apiDescription Add new conversion slave
     * @apiUse _getNode
     *
     * @apiExample (cURL) exmaple:
     * curl -XPOST "https://SERVER/api/v2/files/convert/slave?id=544627ed3c58891f058b4686"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 200 OK
     * {
     *      "id": "944627ed3c58891f058b468e",
     *      "master": "944627ed3c58891f058b4686",
     *      "format": "png",
     * }
     *
     * @param string $id
     * @param string $p
     * @param string $format
     */
    public function postSlaves(string $format, ?string $id = null, ?string $p = null): Response
    {
        $file = $this->fs->getNode($id, $p, File::class);
        $id = $this->converter->addSlave($file, $format);


        return (new Response())->setCode(200)->setBody([
            'id' => (string) $id,
            'master' => (string) $file->getId(),
            'format' => $format,
        ]);
    }

    /**
     * @api {delete} /api/v2/files/:id/convert/slaves Delete slave
     * @apiVersion 2.0.0
     * @apiName deleteSlaves
     * @apiGroup App\Convert
     * @apiPermission none
     * @apiDescription Delete conversion slave
     * @apiUse _getNode
     *
     * @apiExample (cURL) exmaple:
     * curl -XDELETE "https://SERVER/api/v2/files/convert/slave?id=544627ed3c58891f058b4686"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     *
     * @param string $id
     * @param string $p
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $slave
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param bool   $node
     */
    public function deleteSlaves(ObjectId $id, bool $node = false): Response
    {
        $this->converter->deleteSlave($id, $node);

        return (new Response())->setCode(204);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* balloon
7			*
8			* @copyright Copryright (c) 2012-2018 gyselroth GmbH (https://gyselroth.com)
9			* @license GPL-3.0 https://opensource.org/licenses/GPL-3.0
10			*/
11
12			namespace Balloon\App\Convert\Api\v2;
13
14			use Balloon\App\Api\Controller;
15			use Balloon\App\Convert\Converter;
16			use Balloon\Filesystem;
17			use Balloon\Filesystem\Node\File;
18			use Balloon\Server;
19			use Micro\Http\Response;
20			use MongoDB\BSON\ObjectId;
21
22			class Convert extends Controller
23			{
24			/**
25			* Converter.
26			*
27			* @var Converter
28			*/
29			protected $converter;
30
31			/**
32			* Filesystem.
33			*
34			* @var Filesystem
35			*/
36			protected $fs;
37
38			/**
39			* Constructor.
40			*
41			* @param Converter $converter
42			* @param Server $server
43			*/
44			public function __construct(Converter $converter, Server $server)
45			{
46			$this->fs = $server->getFilesystem();
47			$this->converter = $converter;
48			}
49
50			/**
51			* @api {get} /api/v2/files/:id/convert/supported-formats Get supported formats
52			* @apiVersion 2.0.0
53			* @apiName getSupportedFormats
54			* @apiGroup App\Convert
55			* @apiPermission none
56			* @apiDescription Get supported file formats to convert to (formats do vary between files)
57			* @apiUse _getNode
58			*
59			* @apiExample (cURL) exmaple:
60			* curl -XGET "https://SERVER/api/v2/files/convert/supported-formats?id=544627ed3c58891f058b4686"
61			*
62			* @apiSuccess {string[]} - List of supported formats
63			* @apiSuccessExample {string} Success-Response:
64			* HTTP/1.1 200 OK
65			* [
66			* "png",
67			* "jpg",
68			* "tiff"
69			* ]
70			*
71			* @param string $id
72			* @param string $p
73			*/
74			public function getSupportedFormats(?string $id = null, ?string $p = null): Response
75			{
76			$file = $this->fs->getNode($id, $p, File::class);
77			$result = $this->converter->getSupportedFormats($file);
			0 ignored issues – show Compatibility introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report `$file` of type `object<Balloon\Filesystem\Node\NodeInterface>` is not a sub-type of `object<Balloon\Filesystem\Node\File>`. It seems like you assume a concrete implementation of the interface `Balloon\Filesystem\Node\NodeInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
78
79			return (new Response())->setCode(200)->setBody($result);
80			}
81
82			/**
83			* @api {get} /api/v2/files/:id/convert/slaves Get slaves
84			* @apiVersion 2.0.0
85			* @apiName getSlaves
86			* @apiGroup App\Convert
87			* @apiPermission none
88			* @apiDescription Get existing conversion slaves
89			* @apiUse _getNode
90			*
91			* @apiExample (cURL) exmaple:
92			* curl -XGET "https://SERVER/api/v2/files/convert/slaves?id=544627ed3c58891f058b4686"
93			*
94			* @apiSuccessExample {string} Success-Response:
95			* HTTP/1.1 200 OK
96			* [
97			* ]
98			*
99			* @param string $id
100			* @param string $p
101			*/
102			public function getSlaves(?string $id = null, ?string $p = null): Response
103			{
104			$file = $this->fs->getNode($id, $p, File::class);
105			$body = [];
106
107			foreach ($this->converter->getSlaves($file) as $slave) {
			0 ignored issues – show Compatibility introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report `$file` of type `object<Balloon\Filesystem\Node\NodeInterface>` is not a sub-type of `object<Balloon\Filesystem\Node\File>`. It seems like you assume a concrete implementation of the interface `Balloon\Filesystem\Node\NodeInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
108			$element = [
109			'id' => (string) $slave['_id'],
110			'master' => (string) $slave['master'],
111			'format' => $slave['format'],
112			];
113
114			if (isset($slave['slave'])) {
115			$element['slave'] = (string) $slave['slave'];
116			}
117
118			$body[] = $element;
119			}
120
121			return (new Response())->setCode(200)->setBody($body);
122			}
123
124			/**
125			* @api {post} /api/v2/files/:id/convert/slaves Add new slave
126			* @apiVersion 2.0.0
127			* @apiName postSlaves
128			* @apiGroup App\Convert
129			* @apiPermission none
130			* @apiDescription Add new conversion slave
131			* @apiUse _getNode
132			*
133			* @apiExample (cURL) exmaple:
134			* curl -XPOST "https://SERVER/api/v2/files/convert/slave?id=544627ed3c58891f058b4686"
135			*
136			* @apiSuccessExample {string} Success-Response:
137			* HTTP/1.1 200 OK
138			* {
139			* "id": "944627ed3c58891f058b468e",
140			* "master": "944627ed3c58891f058b4686",
141			* "format": "png",
142			* }
143			*
144			* @param string $id
145			* @param string $p
146			* @param string $format
147			*/
148			public function postSlaves(string $format, ?string $id = null, ?string $p = null): Response
149			{
150			$file = $this->fs->getNode($id, $p, File::class);
151			$id = $this->converter->addSlave($file, $format);
			0 ignored issues – show Compatibility introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report `$file` of type `object<Balloon\Filesystem\Node\NodeInterface>` is not a sub-type of `object<Balloon\Filesystem\Node\File>`. It seems like you assume a concrete implementation of the interface `Balloon\Filesystem\Node\NodeInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
152
153			return (new Response())->setCode(200)->setBody([
154			'id' => (string) $id,
155			'master' => (string) $file->getId(),
156			'format' => $format,
157			]);
158			}
159
160			/**
161			* @api {delete} /api/v2/files/:id/convert/slaves Delete slave
162			* @apiVersion 2.0.0
163			* @apiName deleteSlaves
164			* @apiGroup App\Convert
165			* @apiPermission none
166			* @apiDescription Delete conversion slave
167			* @apiUse _getNode
168			*
169			* @apiExample (cURL) exmaple:
170			* curl -XDELETE "https://SERVER/api/v2/files/convert/slave?id=544627ed3c58891f058b4686"
171			*
172			* @apiSuccessExample {string} Success-Response:
173			* HTTP/1.1 204 No Content
174			*
175			* @param string $id
176			* @param string $p
			0 ignored issues – show Bug introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report There is no parameter named `$p`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
177			* @param string $slave
			0 ignored issues – show Bug introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report There is no parameter named `$slave`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
178			* @param bool $node
179			*/
180			public function deleteSlaves(ObjectId $id, bool $node = false): Response
181			{
182			$this->converter->deleteSlave($id, $node);
183
184			return (new Response())->setCode(204);
185			}
186			}
187

gyselroth / balloon

Branch — dev (d5d70c)

Convert::deleteSlaves() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like