ResumeTokenException.php 1.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<?php
/*
 * 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.
 */

namespace MongoDB\Exception;

20 21 22
use function gettype;
use function sprintf;

23
class ResumeTokenException extends RuntimeException
24
{
25
    /**
26
     * Thrown when a resume token has an invalid type.
27
     *
28
     * @param mixed $value Actual value (used to derive the type)
29 30
     * @return self
     */
31
    public static function invalidType($value)
32
    {
33
        return new static(sprintf('Expected resume token to have type "array or object" but found "%s"', gettype($value)));
34 35 36
    }

    /**
37
     * Thrown when a resume token is not found in a change document.
38 39 40
     *
     * @return self
     */
41
    public static function notFound()
42
    {
43
        return new static('Resume token not found in change document');
44
    }
45
}