Surfnet\StepupBundle\Exception\Art

Complexity

Total Complexity

4

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	forException()	0	4	1
A	forFlattenException()	0	4	1
A	calculateArt()	0	6	1
A	stripVariableArgumentsFromMessage()	0	4	1

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupBundle\Exception;

use Exception;
use Symfony\Component\Debug\Exception\FlattenException;

class Art
{
    /**
     * @param Exception $exception
     * @return string
     */
    public static function forException(Exception $exception)
    {
        return self::calculateArt(get_class($exception), $exception->getMessage());
    }

    /**
     * @param FlattenException $exception
     * @return string
     */
    public static function forFlattenException(FlattenException $exception)
    {
        return self::calculateArt($exception->getClass(), $exception->getMessage());
    }

    /**
     * @param string $className
     * @param string $message
     * @return string
     */
    private static function calculateArt($className, $message)
    {
        $message = self::stripVariableArgumentsFromMessage($message);

        return substr(abs(crc32(md5($className . $message))), 0, 5);
    }

    /**
     * Strip variable arguments from exception messages.
     *
     * Some exception messages are formatted using sprintf, and result in a
     * unique art-code for each distinct message. In order for the art-code to
     * be useful it must be the same for each distinct error situation without
     * taking into account variable parts of the message.
     *
     * This method strips all strings inside quotes. This is not perfect
     * because it relies on sprintf arguments to always be quoted inside the
     * message.
     *
     * @param $message
     * @return string
     */
    private static function stripVariableArgumentsFromMessage($message)
    {
        return preg_replace('#".*"|\'.*\'#', '', $message);
    }
}