POData\Providers\Metadata\Type\EdmString

Complexity

Total Complexity

8

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	convertToOData()	0	3	1
A	validate()	0	8	2
A	isCompatibleWith()	0	3	1
A	getFullTypeName()	0	3	1
A	convert()	0	17	2
A	getTypeCode()	0	3	1

<?php

namespace POData\Providers\Metadata\Type;

/**
 * Class EdmString
 * @package POData\Providers\Metadata\Type
 */
class EdmString implements IType
{
    /**
     * Gets the type code
     * Note: implementation of IType::getTypeCode
     *   
     * @return TypeCode
     */
    public function getTypeCode()
    {
        return TypeCode::STRING;

The expression return POData\Providers\Metadata\Type\TypeCode::STRING returns the type integer which is incompatible with the documented return type POData\Providers\Metadata\Type\TypeCode.

    }

    /**
     * Checks this type (EdmString) is compatible with another type
     * Note: implementation of IType::isCompatibleWith
     * 
     * @param IType $type Type to check compatibility
     * 
     * @return boolean 
     */
    public function isCompatibleWith(IType $type)
    {
        return ($type->getTypeCode() == TypeCode::STRING);
    }

    /**
     * Validate a value in Astoria uri is in a format for this type
     * Note: implementation of IType::validate
     * 
     * @param string $value     The value to validate 
     * @param string &$outValue The stripped form of $value that can 
     *                          be used in PHP expressions
     * 
     * @return boolean
     */
    public function validate($value, &$outValue)
    {
        if (!is_string($value)) {

The condition is_string($value) is always true.

            return false;
        }
        
        $outValue = $value;
        return true;
    }

    /**
     * Gets full name of this type in EDM namespace
     * Note: implementation of IType::getFullTypeName
     * 
     * @return string
     */
    public function getFullTypeName()
    {
        return 'Edm.String';
    }

    /**
     * Converts the given string value to string type.
     * 
     * @param string $stringValue value to convert.
     * 
     * @return string
     */
    public function convert($stringValue)
    {
        //Consider the odata url option 
        //$filter=ShipName eq 'Antonio%20Moreno%20Taquer%C3%ADa'
        //WebOperationContext will do urldecode, so the clause become
        //$filter=ShipName eq 'Antonio Moreno Taquería', the lexer will
        //give the token as
        //Token {Text string(25):'Antonio Moreno Taquería', Id: EdmString}, 
        //this function is used to remove the pre-post quotes from Token::Text 
        //i.e. 'Antonio Moreno Taquería'
        //to Antonio Moreno Taquería
        $len = strlen($stringValue);
        if ($len < 2) {
            return $stringValue;
        }

        return substr($stringValue, 1, $len - 2);
    }

    /**
     * Convert the given value to a form that can be used in OData uri. 
     * Note: The calling function should not pass null value, as this 
     * function will not perform any check for nullability 
     * 
     * @param mixed $value value to convert.
     * 
     * @return string
     */
    public function convertToOData($value)
    {
        return '\'' . str_replace('%27', "''", urlencode(utf8_encode($value))) . '\'';
    }
}