RaSecondFactorService::search() - Code Metrics - Inspection of "Merge pull request #53 from OpenConext/feature/exp..." - OpenConext/Stepup-Middleware-clientbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( eacc53...bb9129 )

unknown

created 2017-11-17 13:57 UTC

RaSecondFactorService::search() A

↳ Parent: RaSecondFactorService

Complexity

Conditions	3
Paths	3

Size

Total Lines	20
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddlewareClientBundle\Identity\Service;

use Surfnet\StepupMiddlewareClient\Exception\AccessDeniedToResourceException;
use Surfnet\StepupMiddlewareClient\Exception\MalformedResponseException;
use Surfnet\StepupMiddlewareClient\Exception\ResourceReadException;
use Surfnet\StepupMiddlewareClient\Identity\Dto\RaSecondFactorExportQuery;
use Surfnet\StepupMiddlewareClient\Identity\Dto\RaSecondFactorSearchQuery;
use Surfnet\StepupMiddlewareClient\Identity\Service\RaSecondFactorService as LibraryRaSecondFactorService;
use Surfnet\StepupMiddlewareClientBundle\Exception\InvalidResponseException;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\RaSecondFactorCollection;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\RaSecondFactorExportCollection;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class RaSecondFactorService
{
    /**
     * @var LibraryRaSecondFactorService
     */
    private $service;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @param LibraryRaSecondFactorService $service
     * @param ValidatorInterface $validator
     */
    public function __construct(LibraryRaSecondFactorService $service, ValidatorInterface $validator)
    {
        $this->service = $service;
        $this->validator = $validator;
    }

    /**
     * @param RaSecondFactorSearchQuery $query
     * @return RaSecondFactorCollection

     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function search(RaSecondFactorSearchQuery $query)
    {
        $data = $this->service->search($query);

        if ($data === null) {
            return null;
        }

        $secondFactors = RaSecondFactorCollection::fromData($data);
        $violations = $this->validator->validate($secondFactors);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "One or more second factors retrieved from the Middleware were invalid",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                $violations
            );
        }

        return $secondFactors;
    }
    /**
     * @param RaSecondFactorExportQuery $query
     * @return RaSecondFactorExportCollection

     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function searchForExport(RaSecondFactorExportQuery $query)
    {
        $data = $this->service->export($query);


        if ($data === null) {
            return null;
        }

        $secondFactors = RaSecondFactorExportCollection::fromData($data);
        $violations = $this->validator->validate($secondFactors);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "One or more second factors retrieved from the Middleware were invalid",
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                $violations
            );
        }

        return $secondFactors;
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupMiddlewareClientBundle\Identity\Service;
20
21			use Surfnet\StepupMiddlewareClient\Exception\AccessDeniedToResourceException;
22			use Surfnet\StepupMiddlewareClient\Exception\MalformedResponseException;
23			use Surfnet\StepupMiddlewareClient\Exception\ResourceReadException;
24			use Surfnet\StepupMiddlewareClient\Identity\Dto\RaSecondFactorExportQuery;
25			use Surfnet\StepupMiddlewareClient\Identity\Dto\RaSecondFactorSearchQuery;
26			use Surfnet\StepupMiddlewareClient\Identity\Service\RaSecondFactorService as LibraryRaSecondFactorService;
27			use Surfnet\StepupMiddlewareClientBundle\Exception\InvalidResponseException;
28			use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\RaSecondFactorCollection;
29			use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\RaSecondFactorExportCollection;
30			use Symfony\Component\Validator\Validator\ValidatorInterface;
31
32			/**
33			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
34			*/
35			class RaSecondFactorService
36			{
37			/**
38			* @var LibraryRaSecondFactorService
39			*/
40			private $service;
41
42			/**
43			* @var ValidatorInterface
44			*/
45			private $validator;
46
47			/**
48			* @param LibraryRaSecondFactorService $service
49			* @param ValidatorInterface $validator
50			*/
51			public function __construct(LibraryRaSecondFactorService $service, ValidatorInterface $validator)
52			{
53			$this->service = $service;
54			$this->validator = $validator;
55			}
56
57			/**
58			* @param RaSecondFactorSearchQuery $query
59			* @return RaSecondFactorCollection
			0 ignored issues – show Documentation introduced 2016-06-08 10:22 UTC by Report Bug Copy Issue Report Should the return type not be `RaSecondFactorCollection\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
60			* @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
61			* @throws InvalidResponseException When the API responded with invalid data.
62			* @throws ResourceReadException When the API doesn't respond with the resource.
63			* @throws MalformedResponseException When the API doesn't respond with a proper response.
64			*/
65			public function search(RaSecondFactorSearchQuery $query)
66			{
67			$data = $this->service->search($query);
68
69			if ($data === null) {
70			return null;
71			}
72
73			$secondFactors = RaSecondFactorCollection::fromData($data);
74			$violations = $this->validator->validate($secondFactors);
75
76			if (count($violations) > 0) {
77			throw InvalidResponseException::withViolations(
78			"One or more second factors retrieved from the Middleware were invalid",
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-08 10:22 UTC by Report Bug Copy Issue Report The string literal `One or more second facto...Middleware were invalid` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
79			$violations
80			);
81			}
82
83			return $secondFactors;
84			}
85			/**
86			* @param RaSecondFactorExportQuery $query
87			* @return RaSecondFactorExportCollection
			0 ignored issues – show Documentation introduced 2017-11-17 09:52 UTC by Report Bug Copy Issue Report Should the return type not be `RaSecondFactorExportCollection\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
88			* @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
89			* @throws InvalidResponseException When the API responded with invalid data.
90			* @throws ResourceReadException When the API doesn't respond with the resource.
91			* @throws MalformedResponseException When the API doesn't respond with a proper response.
92			*/
93			public function searchForExport(RaSecondFactorExportQuery $query)
94			{
95			$data = $this->service->export($query);
			0 ignored issues – show Bug introduced 2017-11-17 09:52 UTC by Report Bug Copy Issue Report The method `export()` does not exist on `Surfnet\StepupMiddleware...e\RaSecondFactorService`. Did you maybe mean `searchForExport()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
96
97			if ($data === null) {
98			return null;
99			}
100
101			$secondFactors = RaSecondFactorExportCollection::fromData($data);
102			$violations = $this->validator->validate($secondFactors);
103
104			if (count($violations) > 0) {
105			throw InvalidResponseException::withViolations(
106			"One or more second factors retrieved from the Middleware were invalid",
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-11-17 09:52 UTC by Report Bug Copy Issue Report The string literal `One or more second facto...Middleware were invalid` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
107			$violations
108			);
109			}
110
111			return $secondFactors;
112			}
113			}
114

OpenConext / Stepup-Middleware-clientbundle

Push — develop ( eacc53...bb9129 )

RaSecondFactorService::search() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like