POData\Providers\Metadata\Type\Guid

Complexity

Total Complexity

19

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getTypeCode()	0	3	1
A	convertToOData()	0	3	1
A	isCompatibleWith()	0	3	1
A	guidEqual()	0	6	1
A	convert()	0	8	2
C	validate()	0	25	7
A	getName()	0	3	1
A	validateWithoutPrefix()	0	21	4
A	getFullTypeName()	0	3	1

<?php

namespace POData\Providers\Metadata\Type;

/**
 * Class Guid.
 */
class Guid implements IType
{
    /**
     * Gets the type code
     * Note: implementation of IType::getTypeCode.
     *
     * @return TypeCode
     */
    public function getTypeCode()
    {
        return TypeCode::GUID;

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

    }

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

    /**
     * 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 bool
     */
    public function validate($value, &$outValue)
    {
        ////The GUID value present in the $filter option should have one of the following pattern.
        //1. '/^guid\'([0-9a-fA-F]{32}\')?$/';

60% of this comment could be valid code. Did you maybe forget this after debugging?

        //2. '/^guid\'([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\')?$/';

53% of this comment could be valid code. Did you maybe forget this after debugging?

        //3. '/^guid\'\{?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}?\')?$/';

54% of this comment could be valid code. Did you maybe forget this after debugging?

        //4. '/^guid\'\(?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\)?\')?$/';

54% of this comment could be valid code. Did you maybe forget this after debugging?

        $length = strlen($value);
        if (38 != $length && 42 != $length && 44 != $length) {
            return false;
        }

        if (0 !== strpos($value, 'guid\'') && '\'' != $value[$length - 1]) {
            return false;
        }

        $value = substr($value, 4, $length - 4);
        if (!self::validateWithoutPrefix($value, true)) {

It seems like $value can also be of type false; however, parameter $guid of POData\Providers\Metadata\Type\Guid::validateWithoutPrefix() does only seem to accept string, maybe add an additional type check?

            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.Guid';
    }

    /**
     * Converts the given string value to guid type.
     *
     * @param string $stringValue value to convert
     *
     * @return string
     */
    public function convert($stringValue)
    {
        $len = strlen($stringValue);
        if (2 > $len) {
            return $stringValue;
        }

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

The expression return substr($stringValue, 1, $len - 2) could also return false which is incompatible with the documented return type string. Did you maybe forget to handle an error condition?

    }

    /**
     * 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 'guid\'' . urlencode($value) . '\'';
    }

    /**
     * Validates guid.
     *
     * @param string $guid       The guid to validate
     * @param bool   $withQuotes Whether the above guid have quote as delimiter
     *
     * @return bool
     */
    public static function validateWithoutPrefix($guid, $withQuotes = false)
    {
        if ($withQuotes) {
            $patt = ['/^(\'[0-9a-fA-F]{32}\')?$/',
                '/^(\'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\')?$/',
                '/^\'\{?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}?\')?$/',
                '/^\'\(?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\)?\')?$/', ];
        } else {
            $patt = ['/^([0-9a-fA-F]{32})?$/',
                '/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?$/',
                '/^\{?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}?)?$/',
                '/^\(?([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\)?)?$/', ];
        }

        foreach ($patt as $pattern) {
            if (1 == preg_match($pattern, $guid)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Check the equality of two guids. This function will not validate the
     * guids one should use validate or validateWithoutPrefix to validate the
     * guids before using them with this function.
     *
     * @param string $guid1 First guid
     * @param string $guid2 Second guid
     *
     * @return bool True if both guids are same else false
     */
    public static function guidEqual($guid1, $guid2)
    {
        $guid1 = str_replace(['{', '}', '(', ')', '-'], '', $guid1);
        $guid2 = str_replace(['{', '}', '(', ')', '-'], '', $guid2);

        return 0 === strcasecmp($guid1, $guid2);
    }

    /**
     * Gets full name of the type implementing this interface in EDM namespace
     * Note: implementation of IType::getFullTypeName.
     *
     * @return string
     */
    public function getName()
    {
        return $this->getFullTypeName();
    }
}