InvalidArgumentException.php 2.11 KB
Newer Older
1
<?php
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * Copyright 2015-2017 MongoDB, Inc.
 *
 * 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.
 */
17 18 19

namespace MongoDB\Exception;

20
use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
21 22
use function array_pop;
use function count;
23 24
use function get_class;
use function gettype;
25 26
use function implode;
use function is_array;
27 28
use function is_object;
use function sprintf;
29 30

class InvalidArgumentException extends DriverInvalidArgumentException implements Exception
31
{
32 33 34
    /**
     * Thrown when an argument or option has an invalid type.
     *
35 36 37
     * @param string          $name         Name of the argument or option
     * @param mixed           $value        Actual value (used to derive the type)
     * @param string|string[] $expectedType Expected type
38 39 40 41
     * @return self
     */
    public static function invalidType($name, $value, $expectedType)
    {
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
        if (is_array($expectedType)) {
            switch (count($expectedType)) {
                case 1:
                    $typeString = array_pop($expectedType);
                    break;

                case 2:
                    $typeString = implode('" or "', $expectedType);
                    break;

                default:
                    $lastType = array_pop($expectedType);
                    $typeString = sprintf('%s", or "%s', implode('", "', $expectedType), $lastType);
                    break;
            }

            $expectedType = $typeString;
        }

61 62
        return new static(sprintf('Expected %s to have type "%s" but found "%s"', $name, $expectedType, is_object($value) ? get_class($value) : gettype($value)));
    }
63
}