Stratadox\Deserializer\FailedToDeserializeTheObject

Complexity

Total Complexity

1

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	encountered()	0	6	1

<?php
declare(strict_types=1);

namespace Stratadox\Deserializer;

use RuntimeException;
use Throwable;

/**
 * Notifies the client that the object could not be deserialized.
 *
 * @author Stratadox
 */
final class FailedToDeserializeTheObject extends RuntimeException implements DeserializationFailure
{
    /**
     * Produces a deserialization exception to throw when a "foreign" exception
     * was encountered during the object deserialization process.
     *
     * Prepends the original exception message with additional information on
     * what happened when the problem occurred.
     *
     * @param Throwable $exception    The original exception that was caught
     *                                while deserialization the object.
     * @return DeserializationFailure The deserialization exception to throw in
     *                                place of the encountered exception.
     */
    public static function encountered(Throwable $exception): DeserializationFailure
    {
        return new FailedToDeserializeTheObject(
            'Failed to deserialize the object: ' . $exception->getMessage(),
            0,
            $exception
        );
    }
}