OperationPathResolver::resolveOperationPath() - Code Metrics - Inspection of "Swagger subresource + OperationPathResolver refact..." - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1245)

by Antoine

created 2017-07-11 13:47 UTC

OperationPathResolver::resolveOperationPath() B

↳ Parent: OperationPathResolver

Complexity

Conditions	4
Paths	6

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	11
nc	6
nop	3

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\PathResolver;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Api\OperationTypeDeprecationHelper;
use ApiPlatform\Core\Exception\InvalidArgumentException;

/**
 * Generates an operation path.
 *
 * @author Antoine Bluchet <[email protected]>
 */
final class OperationPathResolver implements OperationPathResolverInterface
{
    private $pathNameGenerator;

    public function __construct(PathNameGeneratorInterface $pathNameGenerator)
    {
        $this->pathNameGenerator = $pathNameGenerator;
    }

    /**
     * {@inheritdoc}
     */
    public function resolveOperationPath(string $resourceShortName, array $operation, $operationType/*, string $operationName = null*/): string
    {
        if (func_num_args() < 4) {
            @trigger_error(sprintf('Method %s() will have a 4th `string $operationName` argument in version 3.0. Not defining it is deprecated since 2.1.', __METHOD__), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        $operationType = OperationTypeDeprecationHelper::getOperationType($operationType);

        if (OperationType::SUBRESOURCE === $operationType) {
            throw new InvalidArgumentException('Subresource operations are not supported by the OperationPathResolver.');
        }

        $path = '/'.$this->pathNameGenerator->getPathName($resourceShortName, true);

        if ($operationType === OperationType::ITEM) {
            $path .= '/{id}';
        }

        $path .= '.{_format}';

        return $path;
    }
}


1			<?php
2
3			/*
4			* This file is part of the API Platform project.
5			*
6			* (c) Kévin Dunglas <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace ApiPlatform\Core\PathResolver;
15
16			use ApiPlatform\Core\Api\OperationType;
17			use ApiPlatform\Core\Api\OperationTypeDeprecationHelper;
18			use ApiPlatform\Core\Exception\InvalidArgumentException;
19
20			/**
21			* Generates an operation path.
22			*
23			* @author Antoine Bluchet <[email protected]>
24			*/
25			final class OperationPathResolver implements OperationPathResolverInterface
26			{
27			private $pathNameGenerator;
28
29			public function __construct(PathNameGeneratorInterface $pathNameGenerator)
30			{
31			$this->pathNameGenerator = $pathNameGenerator;
32			}
33
34			/**
35			* {@inheritdoc}
36			*/
37			public function resolveOperationPath(string $resourceShortName, array $operation, $operationType/, string $operationName = null/): string
38			{
39			if (func_num_args() < 4) {
40			@trigger_error(sprintf('Method %s() will have a 4th `string $operationName` argument in version 3.0. Not defining it is deprecated since 2.1.', __METHOD__), E_USER_DEPRECATED);
			1 ignored issue – show Security Best Practice introduced 2017-06-21 18:29 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
41			}
42
43			$operationType = OperationTypeDeprecationHelper::getOperationType($operationType);
44
45			if (OperationType::SUBRESOURCE === $operationType) {
46			throw new InvalidArgumentException('Subresource operations are not supported by the OperationPathResolver.');
47			}
48
49			$path = '/'.$this->pathNameGenerator->getPathName($resourceShortName, true);
50
51			if ($operationType === OperationType::ITEM) {
52			$path .= '/{id}';
53			}
54
55			$path .= '.{_format}';
56
57			return $path;
58			}
59			}
60

api-platform / core

Pull Request — master (#1245)

OperationPathResolver::resolveOperationPath() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like