GetParamsResultOrder::newInstance() - Code Metrics - alexmanno/trucker - Measure and Improve Code Quality continuously with Scrutinizer

GetParamsResultOrder::newInstance() A
last analyzed 2017-12-13 08:09 UTC

↳ Parent: GetParamsResultOrder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0
crap	2

<?php

namespace Trucker\Finders\Conditions;

use Guzzle\Http\Message\Request;
use Illuminate\Container\Container;
use Trucker\Facades\Config;

/**
 * Class to manage how sorting requirements for results returned by
 * a request, where the directives are passed as HTTP GET parameters with
 * particular parameter names (defined in the config).
 * The resulting GET params might be something like:.
 *
 * <code>
 * order_by=someProperty
 * order_dir=ASC
 * </code>
 */
class GetParamsResultOrder implements QueryResultOrderInterface
{
    /**
     * The IoC Container.
     *
     * @var Container
     */
    protected $app;

    /**
     * Var to hold the order by field
     * that the results shoudl be sorted on.
     *
     * @var string
     */
    protected $orderByField;

    /**
     * Var to hold the order direction
     * for results to be returned.
     *
     * @var string
     */
    protected $orderDirection;

    /**
     * Constructor, likely never called in implementation
     * but rather through the service provider.
     *
     * @param Container $app
     */
    public function __construct(Container $app)
    {
        $this->app = $app;
    }

    /**
     * Function to create a new instance that should
     * be setup with the IoC Container etc.
     *
     * @return GetParamsResultOrder
     */
    public function newInstance()
    {
        return new static($this->app);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * Function to set the property which the results
     * should be ordered by.
     *
     * @param string $propertyName
     */
    public function setOrderByField($propertyName)
    {
        $this->orderByField = $propertyName;
    }

    /**
     * Function to set the direction which the results
     * should be sorted by, ascending, descending.
     *
     * @param string $direction
     *
     * @throws \Exception
     */
    public function setOrderDirection($direction)
    {
        if ($direction != $this->getOrderDirectionAscending() &&
            $direction != $this->getOrderDirectionDescending()
        ) {
            throw new \Exception("Invalid order direction: {$direction}");
        }

        $this->orderDirection = $direction;
    }

    /**
     * Getter function to return the string that represents
     * the ascending sort direction.
     *
     * @return string
     */
    public function getOrderDirectionAscending()
    {
        return Config::get('result_order.get_params.order_dir_ascending');
        return Config::/** @scrutinizer ignore-call */ get('result_order.get_params.order_dir_ascending');
    }

    /**
     * Getter function to return the string that represents
     * the descending sort direction.
     *
     * @return string
     */
    public function getOrderDirectionDescending()
    {
        return Config::get('result_order.get_params.order_dir_descending');
    }

    /**
     * Function to add all the directives that have been
     * given to the class to a given request object.
     *
     * @param Request $request Request passed by reference
     */
    public function addToRequest(Request $request)
    {
        $query = $request->getQuery();

        if (isset($this->orderByField)) {
            $query->add(
                Config::get('result_order.get_params.order_by'),
                $this->orderByField
            );
        }

        if (isset($this->orderDirection)) {
            $query->add(
                Config::get('result_order.get_params.order_dir'),
                $this->orderDirection
            );
        }
    }

    /**
     * Function to convert the directives represented in this class
     * to an array, this is useful for testing.
     *
     * @return array
     */
    public function toArray()
    {
        $order_by = Config::get('result_order.get_params.order_by');
        $order_dir = Config::get('result_order.get_params.order_dir');

        $params = [];
        $params[$order_by] = $this->orderByField;
        $params[$order_dir] = $this->orderDirection;

        return $params;
    }

    /**
     * Function to convert the directives represented in this class
     * to a querystring, this is useful for testing.
     *
     * @return string
     */
    public function toQueryString()
    {
        return http_build_query($this->toArray());
    }
}


alexmanno / trucker

GetParamsResultOrder::newInstance() A last analyzed 2017-12-13 08:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GetParamsResultOrder::newInstance() A
last analyzed 2017-12-13 08:09 UTC