SerialiseNextPageLinksTrait::buildNextPageLink() - Code Metrics - Inspection of "WIP: Refactor IronicSerialiser, round 2" - Algo-Web/POData-Laravel - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#206)

by Alex
created 2020-02-16 03:49 UTC
SerialiseNextPageLinksTrait::buildNextPageLink() A

↳ Parent: SerialiseNextPageLinksTrait
Complexity

Conditions	1
Paths	1
Size

Total Lines	9
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	7
c	1
b	0
f	0
dl	0
loc	9
rs	10
cc	1
nc	1
nop	2
<?php
/**
 * Created by PhpStorm.
 * User: alex
 * Date: 16/02/20
 * Time: 1:18 AM
 */

namespace AlgoWeb\PODataLaravel\Serialisers;

use POData\Common\InvalidOperationException;
use POData\Common\ODataConstants;
use POData\Common\ODataException;
use POData\IService;
use POData\ObjectModel\ODataFeed;
use POData\ObjectModel\ODataLink;
use POData\ObjectModel\ODataURLCollection;
use POData\Providers\Metadata\ResourceSetWrapper;
use POData\Providers\Query\QueryResult;
use POData\UriProcessor\QueryProcessor\ExpandProjectionParser\ExpandedProjectionNode;
use POData\UriProcessor\QueryProcessor\ExpandProjectionParser\RootProjectionNode;
use POData\UriProcessor\QueryProcessor\OrderByParser\InternalOrderByInfo;
use POData\UriProcessor\RequestDescription;
use POData\UriProcessor\SegmentStack;

trait SerialiseNextPageLinksTrait
{
    /**
     * @param QueryResult $entryObjects
     * @param ODataURLCollection|ODataFeed $odata
     * @throws InvalidOperationException
     * @throws ODataException
     */
    protected function buildNextPageLink(QueryResult $entryObjects, $odata)
    {
        $stackSegment = $this->getRequest()->getTargetResourceSetWrapper()->getName();
        $lastObject = end($entryObjects->results);
        $lastObject = end(/** @scrutinizer ignore-type */ $entryObjects->results);
        $segment = $this->getNextLinkUri($lastObject);
        $nextLink = new ODataLink();
        $nextLink->name = ODataConstants::ATOM_LINK_NEXT_ATTRIBUTE_STRING;
        $nextLink->url = rtrim($this->absoluteServiceUri, '/') . '/' . $stackSegment . $segment;
        $odata->nextPageLink = $nextLink;
    }

    /**
     * Wheter next link is needed for the current resource set (feed)
     * being serialized.
     *
     * @param int $resultSetCount Number of entries in the current
     *                            resource set
     *
     * @return bool true if the feed must have a next page link
     * @throws InvalidOperationException
     */
    protected function needNextPageLink($resultSetCount)
    {
        $currentResourceSet = $this->getCurrentResourceSetWrapper();
        $recursionLevel = count($this->getStack()->getSegmentNames());
        $pageSize = $currentResourceSet->getResourceSetPageSize();

        if (1 == $recursionLevel) {
            //presence of $top option affect next link for root container
            $topValueCount = $this->getRequest()->getTopOptionCount();
            if (null !== $topValueCount && ($topValueCount <= $pageSize)) {
                return false;
            }
        }
        return $resultSetCount == $pageSize;
    }


    /**
     * Get next page link from the given entity instance.
     *
     * @param  mixed          &$lastObject Last object serialized to be
     *                                     used for generating
     *                                     $skiptoken
     * @throws ODataException
     * @return string         for the link for next page
     * @throws InvalidOperationException
     */
    protected function getNextLinkUri(&$lastObject)
    {
        $currentExpandedProjectionNode = $this->getCurrentExpandedProjectionNode();
        $internalOrderByInfo = $currentExpandedProjectionNode->getInternalOrderByInfo();
        if (null === $internalOrderByInfo) {
            throw new InvalidOperationException('Null');
        }
        if (!$internalOrderByInfo instanceof InternalOrderByInfo) {

            throw new InvalidOperationException(get_class($internalOrderByInfo));
        }
        $numSegments = count($internalOrderByInfo->getOrderByPathSegments());
        $queryParameterString = $this->getNextPageLinkQueryParametersForRootResourceSet();

        $skipToken = $internalOrderByInfo->buildSkipTokenValue($lastObject);
        if (empty($skipToken)) {
            throw new InvalidOperationException('!is_null($skipToken)');
        }
        $token = (1 < $numSegments) ? '$skiptoken=' : '$skip=';
        $skipToken = (1 < $numSegments) ? $skipToken : intval(trim($skipToken, '\''));
        $skipToken = '?' . $queryParameterString . $token . $skipToken;

        return $skipToken;
    }

    /**
     * Builds the string corresponding to query parameters for top level results
     * (result set identified by the resource path) to be put in next page link.
     *
     * @return string|null string representing the query parameters in the URI
     *                     query parameter format, NULL if there
     *                     is no query parameters
     *                     required for the next link of top level result set
     * @throws InvalidOperationException
     */
    protected function getNextPageLinkQueryParametersForRootResourceSet()
    {
        /** @var string|null $queryParameterString */
        $queryParameterString = null;
        foreach ([ODataConstants::HTTPQUERY_STRING_FILTER,
                     ODataConstants::HTTPQUERY_STRING_EXPAND,
                     ODataConstants::HTTPQUERY_STRING_ORDERBY,
                     ODataConstants::HTTPQUERY_STRING_INLINECOUNT,
                     ODataConstants::HTTPQUERY_STRING_SELECT, ] as $queryOption) {
            /** @var string|null $value */
            $value = $this->getService()->getHost()->getQueryStringItem($queryOption);
            if (null !== $value) {
                if (null !== $queryParameterString) {
                    $queryParameterString = /** @scrutinizer ignore-type */$queryParameterString . '&';
                }

                $queryParameterString .= $queryOption . '=' . $value;
            }
        }

        $topCountValue = $this->getRequest()->getTopOptionCount();
        if (null !== $topCountValue) {
            $remainingCount = $topCountValue-$this->getRequest()->getTopCount();
            if (0 < $remainingCount) {
                if (null !== $queryParameterString) {
                    $queryParameterString .= '&';
                }

                $queryParameterString .= ODataConstants::HTTPQUERY_STRING_TOP . '=' . $remainingCount;
            }
        }

        if (null !== $queryParameterString) {
            $queryParameterString .= '&';
        }

        return $queryParameterString;
    }

    /**
     * Gets reference to the request submitted by client.
     *
     * @return RequestDescription
     * @throws InvalidOperationException
     */
    abstract public function getRequest();

    /**
     * Gets the segment stack instance.
     *
     * @return SegmentStack
     */
    abstract public function getStack();

    /**
     * Resource set wrapper for the resource being serialized.
     *
     * @return ResourceSetWrapper
     * @throws InvalidOperationException
     */
    abstract protected function getCurrentResourceSetWrapper();

    /**
     * Find a 'ExpandedProjectionNode' instance in the projection tree
     * which describes the current segment.
     *
     * @return null|RootProjectionNode|ExpandedProjectionNode
     * @throws InvalidOperationException
     */
    abstract protected function getCurrentExpandedProjectionNode();

    /**
     * Gets the data service instance.
     *
     * @return IService
     */
    abstract public function getService();
}

Algo-Web / POData-Laravel

Pull Request — master (#206)

SerialiseNextPageLinksTrait::buildNextPageLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
