AlgoWeb\PODataLaravel\Query\LaravelExpressionProvider

Complexity

Total Complexity

36

Size/Duplication

Total Lines	338
Duplicated Lines	10.65 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setResourceType()	0	4	1
A	onPropertyAccessExpression()	0	11	2
A	unpackExpressionType()	0	8	2
A	onUnaryExpression()	10	10	3
B	onArithmeticExpression()	0	16	6
A	getResourceType()	0	3	1
A	onLogicalExpression()	10	10	3
A	prepareUnaryExpression()	0	3	1
A	onFunctionCallExpression()	0	9	3
B	__construct()	12	78	2
B	onRelationalExpression()	0	18	7
A	getIteratorName()	0	3	1
A	prepareBinaryExpression()	0	3	1
A	onConstantExpression()	0	8	3

<?php

namespace AlgoWeb\PODataLaravel\Query;

use POData\Common\ODataConstants;
use POData\Providers\Expression\IExpressionProvider;
use POData\Providers\Metadata\ResourceType;
use POData\Providers\Metadata\Type\IType;
use POData\UriProcessor\QueryProcessor\ExpressionParser\Expressions\ExpressionType;
use POData\UriProcessor\QueryProcessor\ExpressionParser\Expressions\PropertyAccessExpression;

class LaravelExpressionProvider implements IExpressionProvider
{
    const ADD = '+';
    const CLOSE_BRACKET = ')';
    const COMMA = ',';
    const DIVIDE = '/';
    const SUBTRACT = '-';
    const EQUAL = '==';
    const GREATER_THAN = '>';
    const GREATER_THAN_OR_EQUAL = '>=';
    const LESS_THAN = '<';
    const LESS_THAN_OR_EQUAL = '<=';
    const LOGICAL_AND = '&&';
    const LOGICAL_NOT = '!';
    const LOGICAL_OR = '||';
    const MEMBER_ACCESS = '->';
    const MODULO = '%';
    const MULTIPLY = '*';
    const NEGATE = '-';
    const NOT_EQUAL = '!=';
    const OPEN_BRACKET = '(';
    const TYPE_NAMESPACE = 'POData\\Providers\\Metadata\\Type\\';

    private $functionDescriptionParsers;

    /**
     * The name of iterator.
     *
     * @var string
     */
    private $iteratorName;
    /**
     * The type of the resource pointed by the resource path segment.
     *
     * @var ResourceType
     */
    private $resourceType;

    public function __construct()
    {
        $this->functionDescriptionParsers[ODataConstants::STRFUN_COMPARE] = function ($params) {
            return 'strcmp(' . $params[0] . ', ' . $params[1] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_ENDSWITH] = function ($params) {
            return '(strcmp(substr(' . $params[0] . ', strlen(' . $params[0] . ') - strlen(' . $params[1] . ')), '
                   .$params[1] . ') === 0)';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_INDEXOF] = function ($params) {
            return 'strpos(' . $params[0] . ', ' . $params[1] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_REPLACE] = function ($params) {
            return 'str_replace(' . $params[1] . ', ' . $params[2] . ', ' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_STARTSWITH] = function ($params) {
            return '(strpos(' . $params[0] . ', ' . $params[1] . ') === 0)';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_TOLOWER] = function ($params) {
            return 'strtolower(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_TOUPPER] = function ($params) {
            return 'strtoupper(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_TRIM] = function ($params) {
            return 'trim(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_SUBSTRING] = function ($params) {
            return count($params) == 3 ?
                'substr(' . $params[0] . ', ' . $params[1] . ', ' . $params[2] . ')' : 'substr(' . $params[0] . ', ' . $params[1] . ')';

This line exceeds maximum limit of 120 characters; contains 136 characters

        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_SUBSTRINGOF] = function ($params) {
            return '(strpos(' . $params[1] . ', ' . $params[0] . ') !== false)';
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_CONCAT] = function ($params) {
            return $params[0] . ' . ' . $params[1];
        };
        $this->functionDescriptionParsers[ODataConstants::STRFUN_LENGTH] = function ($params) {
            return 'strlen(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::GUIDFUN_EQUAL] = function ($params) {
            return self::TYPE_NAMESPACE . 'Guid::guidEqual(' . $params[0] . ', ' . $params[1] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_COMPARE] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::dateTimeCmp(' . $params[0] . ', ' . $params[1] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_YEAR] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::year(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_MONTH] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::month(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_DAY] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::day(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_HOUR] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::hour(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_MINUTE] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::minute(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::DATETIME_SECOND] = function ($params) {
            return self::TYPE_NAMESPACE . 'DateTime::second(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::MATHFUN_ROUND] = function ($params) {
            return 'round(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::MATHFUN_CEILING] = function ($params) {
            return 'ceil(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::MATHFUN_FLOOR] = function ($params) {
            return 'floor(' . $params[0] . ')';
        };
        $this->functionDescriptionParsers[ODataConstants::BINFUL_EQUAL] = function ($params) {
            return self::TYPE_NAMESPACE . 'Binary::binaryEqual(' . $params[0] . ', ' . $params[1] . ')';
        };
        $this->functionDescriptionParsers['is_null'] = function ($params) {
            return 'is_null(' . $params[0] . ')';
        };
    }
    /**
     * Get the name of the iterator.
     *
     * @return string
     */
    public function getIteratorName()
    {
        return $this->iteratorName;
    }

    /**
     * Get the resource type.
     *
     * @return object|null
     */
    public function getResourceType()
    {
        return $this->resourceType;

The expression return $this->resourceType returns the type POData\Providers\Metadata\ResourceType which is incompatible with the documented return type object|null.

    }

    /**
     * call-back for setting the resource type.
     *
     * @param ResourceType $resourceType The resource type on which the filter
     *                                   is going to be applied
     */
    public function setResourceType(ResourceType $resourceType)
    {
        $this->iteratorName = '$' . $resourceType->getName();
        $this->resourceType = $resourceType;
    }
    /**
     * Call-back for logical expression.
     *
     * @param ExpressionType $expressionType The type of logical expression
     * @param string         $left           The left expression
     * @param string         $right          The left expression
     *
     * @return string
     */
    public function onLogicalExpression($expressionType, $left, $right)
    {
        $type = $this->unpackExpressionType($expressionType);
        switch ($type) {
            case ExpressionType::AND_LOGICAL:
                return $this->prepareBinaryExpression(self::LOGICAL_AND, $left, $right);
            case ExpressionType::OR_LOGICAL:
                return $this->prepareBinaryExpression(self::LOGICAL_OR, $left, $right);
            default:
                throw new \InvalidArgumentException('onLogicalExpression');
        }
    }
    /**
     * Call-back for arithmetic expression.
     *
     * @param ExpressionType $expressionType The type of arithmetic expression
     * @param string         $left           The left expression
     * @param string         $right          The left expression
     *
     * @return string
     */
    public function onArithmeticExpression($expressionType, $left, $right)
    {
        $type = $this->unpackExpressionType($expressionType);
        switch ($type) {
            case ExpressionType::MULTIPLY:
                return $this->prepareBinaryExpression(self::MULTIPLY, $left, $right);
            case ExpressionType::DIVIDE:
                return $this->prepareBinaryExpression(self::DIVIDE, $left, $right);
            case ExpressionType::MODULO:
                return $this->prepareBinaryExpression(self::MODULO, $left, $right);
            case ExpressionType::ADD:
                return $this->prepareBinaryExpression(self::ADD, $left, $right);
            case ExpressionType::SUBTRACT:
                return $this->prepareBinaryExpression(self::SUBTRACT, $left, $right);
            default:
                throw new \InvalidArgumentException('onArithmeticExpression');
        }
    }
    /**
     * Call-back for relational expression.
     *
     * @param ExpressionType $expressionType The type of relation expression
     * @param string         $left           The left expression
     * @param string         $right          The left expression
     *
     * @return string
     */
    public function onRelationalExpression($expressionType, $left, $right)
    {
        $type = $this->unpackExpressionType($expressionType);
        switch ($type) {
            case ExpressionType::GREATERTHAN:
                return $this->prepareBinaryExpression(self::GREATER_THAN, $left, $right);
            case ExpressionType::GREATERTHAN_OR_EQUAL:
                return $this->prepareBinaryExpression(self::GREATER_THAN_OR_EQUAL, $left, $right);
            case ExpressionType::LESSTHAN:
                return $this->prepareBinaryExpression(self::LESS_THAN, $left, $right);
            case ExpressionType::LESSTHAN_OR_EQUAL:
                return $this->prepareBinaryExpression(self::LESS_THAN_OR_EQUAL, $left, $right);
            case ExpressionType::EQUAL:
                return $this->prepareBinaryExpression(self::EQUAL, $left, $right);
            case ExpressionType::NOTEQUAL:
                return $this->prepareBinaryExpression(self::NOT_EQUAL, $left, $right);
            default:
                throw new \InvalidArgumentException('onRelationalExpression');
        }
    }
    /**
     * Call-back for unary expression.
     *
     * @param ExpressionType $expressionType The type of unary expression
     * @param string         $child          The child expression
     *
     * @return string
     */
    public function onUnaryExpression($expressionType, $child)
    {
        $type = $this->unpackExpressionType($expressionType);
        switch ($type) {
            case ExpressionType::NEGATE:
                return $this->prepareUnaryExpression(self::NEGATE, $child);
            case ExpressionType::NOT_LOGICAL:
                return $this->prepareUnaryExpression(self::LOGICAL_NOT, $child);
            default:
                throw new \InvalidArgumentException('onUnaryExpression');
        }
    }
    /**
     * Call-back for constant expression.
     *
     * @param IType $type  The type of constant
     * @param mixed $value The value of the constant
     *
     * @return string
     */
    public function onConstantExpression(IType $type, $value)
    {
        if (is_bool($value)) {
            return var_export($value, true);
        } elseif (null === $value) {
            return var_export(null, true);
        }
        return $value;
    }
    /**
     * Call-back for property access expression.
     *
     * @param PropertyAccessExpression $expression The property access expression
     *
     * @return string
     */
    public function onPropertyAccessExpression($expression)
    {
        $parent = $expression;
        $variable = null;
        do {
            $variable = $parent->getResourceProperty()->getName() . self::MEMBER_ACCESS . $variable;
            $parent = $parent->getParent();
        } while ($parent != null);
        $variable = rtrim($variable, self::MEMBER_ACCESS);
        $variable = $this->getIteratorName() . self::MEMBER_ACCESS . $variable;
        return $variable;
    }
    /**
     * Call-back for function call expression.
     *
     * @param \POData\UriProcessor\QueryProcessor\FunctionDescription $functionDescription Description of the function
     * @param array<string>                                           $params              Parameters to the function
     *
     * @return string
     */
    public function onFunctionCallExpression($functionDescription, $params)
    {
        if (!isset($functionDescription)) {
            throw new \InvalidArgumentException('onFunctionCallExpression');
        }
        if (!array_key_exists($functionDescription->name, $this->functionDescriptionParsers)) {
            throw new \InvalidArgumentException('onFunctionCallExpression');
        }
        return $this->functionDescriptionParsers[$functionDescription->name]($params);
    }
    /**
     * To format binary expression.
     *
     * @param string $operator The binary operator
     * @param string $left     The left operand
     * @param string $right    The right operand
     *
     * @return string
     */
    private function prepareBinaryExpression($operator, $left, $right)
    {
        return self::OPEN_BRACKET . $left . ' ' . $operator . ' ' . $right . self::CLOSE_BRACKET;
    }
    /**
     * To format unary expression.
     *
     * @param string $operator The unary operator
     * @param string $child    The operand
     *
     * @return string
     */
    private function prepareUnaryExpression($operator, $child)
    {
        return $operator . self::OPEN_BRACKET . $child . self::CLOSE_BRACKET;
    }

    /**
     * @param $expressionType
     * @return mixed
     */
    private function unpackExpressionType($expressionType)
    {
        if ($expressionType instanceof ExpressionType) {
            $type = $expressionType->getValue();
        } else {
            $type = $expressionType;
        }
        return $type;
    }
}