Surfnet\StepupMiddlewareClient\Identity\Dto\RaListingSearchQuery

Complexity

Total Complexity

7

Size/Duplication

Total Lines	94
Duplicated Lines	22.34 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	10	10	1
A	setOrderBy()	0	8	1
A	setOrderDirection()	11	11	2
A	toHttpQuery()	0	16	1
A	assertNonEmptyString()	0	10	2

<?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 $actorInstitution;

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

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

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

    /**
     * @param string $institution

There is no parameter named $institution. Did you maybe mean $actorInstitution?

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

This method seems to be duplicated in your project.

    {
        $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->actorInstitution = $actorInstitution;
        $this->pageNumber  = $pageNumber;
    }

    /**
     * @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)

This method seems to be duplicated in your project.

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

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

        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(
                [
                    'actorInstitution' => $this->actorInstitution,
                    'orderBy'          => $this->orderBy,
                    'orderDirection'   => $this->orderDirection,
                    'p'                => $this->pageNumber,
                ],
                function ($value) {
                    return !is_null($value);
                }
            )
        );
    }
}