IntToCombinedStringsListType::escape() - Code Metrics - Inspection of "Merge pull request #2615 from roadster31/feature-v..." - thelia/thelia - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 2b5c6e...94acd2 )

by Gilles
created 2019-02-07 15:57 UTC
IntToCombinedStringsListType::escape() A

↳ Parent: IntToCombinedStringsListType
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
<?php
/*************************************************************************************/
/*      This file is part of the Thelia package.                                     */
/*                                                                                   */
/*      Copyright (c) OpenStudio                                                     */
/*      email : [email protected]                                                       */
/*      web : http://www.thelia.net                                                  */
/*                                                                                   */
/*      For the full copyright and license information, please view the LICENSE.txt  */
/*      file that was distributed with this source code.                             */
/*************************************************************************************/

namespace Thelia\Type;

/**
 * This class manages boolea expression, in the form:
 * number:expr, number:expr, ...
 * expr: string|(expr oper expr)
 * oper: | or &
 * Special characters , : ( ) & | should be escaped in strings, for example a\(b\).
 *
 * Sample expression : 1: foo & bar | (fooo &baar), 4: *, 67: (foooo & baaar), 11:(abc & def\&ghi\|ttt)
 *
 * @author Etienne Roudeix <[email protected]>, Franck Allimant <[email protected]>
 */
class IntToCombinedStringsListType extends BaseType
{
    public function getType()
    {
        return 'Int to combined strings list type';
    }

    public function isValid($values)
    {
        // Explode expession parts, ignoring escaped characters, (\, and \:)
        foreach (preg_split('#(?<!\\\),#', $values) as $intToCombinedStrings) {
            $parts = preg_split('#(?<!\\\):#', $intToCombinedStrings);

            if (count($parts) != 2) {
            if (count(/** @scrutinizer ignore-type */ $parts) != 2) {
                return false;
            }
            if (filter_var($parts[0], FILTER_VALIDATE_INT) === false) {
                return false;
            }

            if (false === $this->checkLogicalFormat($parts[1])) {
                return false;
            }
        }

        return true;
    }

    public function getFormattedValue($values)
    {
        if ($this->isValid($values)) {
            $return = [];

            foreach (preg_split('/(?<!\\\),/', $values) as $intToCombinedStrings) {
                $parts = preg_split('/(?<!\\\):/', $intToCombinedStrings);

                $return[trim($parts[0])] = array(
                    "values" =>  array_map(
                        function ($item) {
                            return trim(self::unescape($item));
                        },
                        preg_split(
                        /** @scrutinizer ignore-type */ preg_split(
                            '#(?<!\\\)[&|]#',
                            preg_replace(
                                '#(?<!\\\)[\(\)]#',
                                '',
                                $parts[1]
                            )
                        )
                    ),
                    "expression" =>  trim(self::unescape($parts[1])),
                );
            }

            return $return;
        } else {
            return null;
        }
    }


    /**
     * Escape a string to use it safely in an expression. abc:def => abc\:def.
     * Escapes characters are , : ( ) | &
     *
     * @param $string
     * @return string
     */
    public static function escape($string)
    {
        return preg_replace('/([,\:\(\)\|\&])/', '\\\$1', $string);
    }

    /**
     * Unescape a string and remove avai escape symbols. abc\:def => abc:def.
     *
     * @param $string
     * @return string
     */
    public static function unescape($string)
    {
        return preg_replace('/\\\([,\:\(\)\|\&])/', '\1', $string);
    }

    protected function checkLogicalFormat($string)
    {
        // Delete escaped characters
        $string = preg_replace('/\\\[,\:\(\)\|\&]/', '', $string);

        /* delete  all spaces and parentheses */
        $noSpaceString = preg_replace('#[\s]#', '', $string);
        $noParentheseString = preg_replace('#[\(\)]#', '', $noSpaceString);

        if (!preg_match('#^([a-zA-Z0-9_\-]+([\&\|][a-zA-Z0-9_\-]+)*|\*)$#', $noParentheseString)) {
            return false;
        }

        /* check parenteses use */
        $openingParenthesesCount = 0;
        $closingParenthesesCount = 0;

        $length = strlen($noSpaceString);
        for ($i=0; $i< $length; $i++) {
            $char = $noSpaceString[$i];
            if ($char == '(') {
                /* must be :
                 * - after a &| or () or at the begining of expression
                 * - before a number or ()
                 * must not be :
                 * - at the end of expression
                 */
                if (($i!=0 && !preg_match('#[\(\)\&\|]#', $noSpaceString[$i-1])) || !isset($noSpaceString[$i+1]) || !preg_match('#[\(\)a-zA-Z0-9_\-]#', $noSpaceString[$i+1])) {
                    return false;
                }
                $openingParenthesesCount++;
            } elseif ($char == ')') {
                /* must be :
                 * - after a number or ()
                 * - before a &| or () or at the end of expression
                 * must not be :
                 * - at the begining of expression
                 * - if no ( remain unclose
                 */
                if ($i == 0 || !preg_match('#[\(\)a-zA-Z0-9_\-]#', $noSpaceString[$i-1]) || (isset($noSpaceString[$i+1]) && !preg_match('#[\(\)\&\|]#', $noSpaceString[$i+1])) || $openingParenthesesCount-$closingParenthesesCount==0) {
                    return false;
                }
                $closingParenthesesCount++;
            }
        }

        if ($openingParenthesesCount != $closingParenthesesCount) {
            return false;
        }

        return true;
    }

    public function getFormType()
    {
        return 'text';
    }

    public function getFormOptions()
    {
        return array();
    }
}

thelia / thelia

Push — master ( 2b5c6e...94acd2 )

IntToCombinedStringsListType::escape() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
