1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 

<?php

/**
 * This file is part of the phpcommon/comparison package.
 *
 * (c) Marcos Passos <marcos@marcospassos.com>
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 */

namespace PhpCommon\Comparison;

use InvalidArgumentException;
use Exception;

/**
 * Thrown when values provided for comparison are incomparable.
 *
 * @author Marcos Passos <marcos@croct.com>
 */
class IncomparableException extends InvalidArgumentException
{
    /**
     * Creates a new exception for the given value type.
     *
     * @param string         $type  The name of the expected type.
     * @param mixed          $value The specified value.
     * @param int            $code  The exception code.
     * @param Exception|null $cause The exception that caused this exception.
     *
     * @return UnexpectedTypeException The new exception.
     */
    public static function forType($type, $value, $code = 0, Exception $cause = null)
    {
        return new self(
            sprintf(
                'Unable to compare "%s" with "%s".',
                $type,
                is_object($value) ? get_class($value) : gettype($value)
            ),
            $code,
            $cause
        );
    }
}