RaListingSearchQuery::setEmail() - Code Metrics - Inspection of "Update CHANGELOG.md" - OpenConext/Stepup-Middleware-clientbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( ab1e79...587df4 )

by Michiel

created 2019-02-13 08:18 UTC

RaListingSearchQuery::setEmail() A

↳ Parent: RaListingSearchQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
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\StepupMiddlewareClient\Identity\Dto;

use Assert;
use Surfnet\StepupMiddlewareClient\Dto\HttpQuery;

final class RaListingSearchQuery implements HttpQuery
{
    /**
     * @var string
     */
    private $actorId;

    /**
     * @var string
     */
    private $actorInstitution;

    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $email;

    /**
     * @var string
     */
    private $role;

    /**
     * @var string
     */
    private $raInstitution;

    /**
     * @var string|null
     */
    private $institution;

    /**
     * @var string|null
     */
    private $identityId;

    /**
     * @var int
     */
    private $pageNumber;

    /**
     * @var string|null
     */
    private $orderBy = 'commonName';

    /**
     * @var string|null
     */
    private $orderDirection = 'asc';

    /**
     * @param string $actorId
     * @param string string $actorInstitution
     * @param int $pageNumber
     */
    public function __construct($actorId, $actorInstitution, $pageNumber)

    {
        $this->assertNonEmptyString($actorId, 'actorId');
        $this->assertNonEmptyString($actorInstitution, 'actorInstitution');
        Assert\that($pageNumber)
            ->integer('Page number must be an integer')
            ->min(0, 'Page number must be greater than or equal to 1');

        $this->actorId = $actorId;
        $this->actorInstitution = $actorInstitution;
        $this->pageNumber  = $pageNumber;
    }

    /**
     * @param string $institution
     * @return $this
     */
    public function setInstitution($institution)
    {
        $this->assertNonEmptyString($institution, 'institution');

        $this->institution = $institution;

        return $this;
    }

    /**
     * @param string $identityId
     * @return RaListingSearchQuery
     */
    public function setIdentityId($identityId)
    {
        $this->assertNonEmptyString($identityId, 'identityId');

        $this->identityId = $identityId;

        return $this;
    }

    /**
     * @param string $orderBy
     * @return RaListingSearchQuery
     */
    public function setOrderBy($orderBy)
    {
        $this->assertNonEmptyString($orderBy, 'orderBy');

        $this->orderBy = $orderBy;

        return $this;
    }

    /**
     * @param string|null $orderDirection
     * @return RaListingSearchQuery
     */
    public function setOrderDirection($orderDirection)

    {
        Assert\that($orderDirection)->choice(
            ['asc', 'desc', '', null],
            "Invalid order direction, must be one of 'asc', 'desc'"
        );

        $this->orderDirection = $orderDirection ?: null;

        return $this;
    }

    /**
     * @param string $name
     * @return RaListingSearchQuery
     */
    public function setName($name)
    {
        $this->assertNonEmptyString($name, 'name');
        $this->name = $name;
        return $this;
    }

    /**
     * @param string $email
     * @return RaListingSearchQuery
     */
    public function setEmail($email)
    {
        $this->assertNonEmptyString($email, 'email');
        $this->email = $email;
        return $this;
    }

    /**
     * @param string $role
     * @return RaListingSearchQuery
     */
    public function setRole($role)
    {
        $this->assertNonEmptyString($role, 'role');
        $this->role = $role;
        return $this;
    }

    /**
     * @param string $raInstitution
     * @return RaListingSearchQuery
     */
    public function setRaInstitution($raInstitution)
    {
        $this->assertNonEmptyString($raInstitution, 'raInstitution');
        $this->raInstitution = $raInstitution;
        return $this;
    }

    private function assertNonEmptyString($value, $parameterName)

    {
        $message = sprintf(
            '"%s" must be a non-empty string, "%s" given',
            $parameterName,
            (is_object($value) ? get_class($value) : gettype($value))
        );

        Assert\that($value)->string($message)->notEmpty($message);
    }

    public function toHttpQuery()

    {
        return '?'.http_build_query(
            array_filter(
                [
                    'actorId' => $this->actorId,
                    'actorInstitution' => $this->actorInstitution,
                    'institution' => $this->institution,
                    'identityId' => $this->identityId,
                    'name' => $this->name,
                    'email' => $this->email,
                    'role' => $this->role,
                    'raInstitution' => $this->raInstitution,
                    'orderBy' => $this->orderBy,
                    'orderDirection' => $this->orderDirection,
                    'p' => $this->pageNumber,
                ],
                function ($value) {
                    return !is_null($value);
                }
            )
        );
    }
}


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\StepupMiddlewareClient\Identity\Dto;
20
21		use Assert;
22		use Surfnet\StepupMiddlewareClient\Dto\HttpQuery;
23
24		final class RaListingSearchQuery implements HttpQuery
25		{
26		/**
27		* @var string
28		*/
29		private $actorId;
30
31		/**
32		* @var string
33		*/
34		private $actorInstitution;
35
36		/**
37		* @var string
38		*/
39		private $name;
40
41		/**
42		* @var string
43		*/
44		private $email;
45
46		/**
47		* @var string
48		*/
49		private $role;
50
51		/**
52		* @var string
53		*/
54		private $raInstitution;
55
56		/**
57		* @var string\|null
58		*/
59		private $institution;
60
61		/**
62		* @var string\|null
63		*/
64		private $identityId;
65
66		/**
67		* @var int
68		*/
69		private $pageNumber;
70
71		/**
72		* @var string\|null
73		*/
74		private $orderBy = 'commonName';
75
76		/**
77		* @var string\|null
78		*/
79		private $orderDirection = 'asc';
80
81		/**
82		* @param string $actorId
83		* @param string string $actorInstitution
84		* @param int $pageNumber
85		*/
86	View Code Duplication	public function __construct($actorId, $actorInstitution, $pageNumber)
		0 ignored issues – show Duplication introduced 2019-02-08 14:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87		{
88		$this->assertNonEmptyString($actorId, 'actorId');
89		$this->assertNonEmptyString($actorInstitution, 'actorInstitution');
90		Assert\that($pageNumber)
91		->integer('Page number must be an integer')
92		->min(0, 'Page number must be greater than or equal to 1');
93
94		$this->actorId = $actorId;
95		$this->actorInstitution = $actorInstitution;
96		$this->pageNumber = $pageNumber;
97		}
98
99		/**
100		* @param string $institution
101		* @return $this
102		*/
103		public function setInstitution($institution)
104		{
105		$this->assertNonEmptyString($institution, 'institution');
106
107		$this->institution = $institution;
108
109		return $this;
110		}
111
112		/**
113		* @param string $identityId
114		* @return RaListingSearchQuery
115		*/
116		public function setIdentityId($identityId)
117		{
118		$this->assertNonEmptyString($identityId, 'identityId');
119
120		$this->identityId = $identityId;
121
122		return $this;
123		}
124
125		/**
126		* @param string $orderBy
127		* @return RaListingSearchQuery
128		*/
129		public function setOrderBy($orderBy)
130		{
131		$this->assertNonEmptyString($orderBy, 'orderBy');
132
133		$this->orderBy = $orderBy;
134
135		return $this;
136		}
137
138		/**
139		* @param string\|null $orderDirection
140		* @return RaListingSearchQuery
141		*/
142	View Code Duplication	public function setOrderDirection($orderDirection)
		0 ignored issues – show Duplication introduced 2017-11-14 07:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
143		{
144		Assert\that($orderDirection)->choice(
145		['asc', 'desc', '', null],
146		"Invalid order direction, must be one of 'asc', 'desc'"
147		);
148
149		$this->orderDirection = $orderDirection ?: null;
150
151		return $this;
152		}
153
154		/**
155		* @param string $name
156		* @return RaListingSearchQuery
157		*/
158		public function setName($name)
159		{
160		$this->assertNonEmptyString($name, 'name');
161		$this->name = $name;
162		return $this;
163		}
164
165		/**
166		* @param string $email
167		* @return RaListingSearchQuery
168		*/
169		public function setEmail($email)
170		{
171		$this->assertNonEmptyString($email, 'email');
172		$this->email = $email;
173		return $this;
174		}
175
176		/**
177		* @param string $role
178		* @return RaListingSearchQuery
179		*/
180		public function setRole($role)
181		{
182		$this->assertNonEmptyString($role, 'role');
183		$this->role = $role;
184		return $this;
185		}
186
187		/**
188		* @param string $raInstitution
189		* @return RaListingSearchQuery
190		*/
191		public function setRaInstitution($raInstitution)
192		{
193		$this->assertNonEmptyString($raInstitution, 'raInstitution');
194		$this->raInstitution = $raInstitution;
195		return $this;
196		}
197
198	View Code Duplication	private function assertNonEmptyString($value, $parameterName)
		0 ignored issues – show Duplication introduced 2017-11-14 07:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
199		{
200		$message = sprintf(
201		'"%s" must be a non-empty string, "%s" given',
202		$parameterName,
203		(is_object($value) ? get_class($value) : gettype($value))
204		);
205
206		Assert\that($value)->string($message)->notEmpty($message);
207		}
208
209	View Code Duplication	public function toHttpQuery()
		0 ignored issues – show Duplication introduced 2019-02-12 14:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
210		{
211		return '?'.http_build_query(
212		array_filter(
213		[
214		'actorId' => $this->actorId,
215		'actorInstitution' => $this->actorInstitution,
216		'institution' => $this->institution,
217		'identityId' => $this->identityId,
218		'name' => $this->name,
219		'email' => $this->email,
220		'role' => $this->role,
221		'raInstitution' => $this->raInstitution,
222		'orderBy' => $this->orderBy,
223		'orderDirection' => $this->orderDirection,
224		'p' => $this->pageNumber,
225		],
226		function ($value) {
227		return !is_null($value);
228		}
229		)
230		);
231		}
232		}
233

OpenConext / Stepup-Middleware-clientbundle

Push — develop ( ab1e79...587df4 )

RaListingSearchQuery::setEmail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like