Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionException

Complexity

Total Complexity

7

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	directoryNotWritable()	0	4	1
A	directoryRequired()	0	4	1
A	namespaceRequired()	0	4	1
A	invalidParameterTypeHint()	0	17	1
A	invalidReturnTypeHint()	0	12	1
A	parentClassRequired()	0	10	1
A	ownerRequiredToLoadCollection()	0	4	1

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\PersistentCollection;

use Doctrine\ODM\MongoDB\MongoDBException;
use Throwable;
use function sprintf;

/**
 * MongoDB ODM PersistentCollection Exception.
 */
class PersistentCollectionException extends MongoDBException
{
    public static function directoryNotWritable() : self
    {
        return new self('Your PersistentCollection directory must be writable.');
    }

    public static function directoryRequired() : self
    {
        return new self('You must configure a PersistentCollection directory. See docs for details.');
    }

    public static function namespaceRequired() : self
    {
        return new self('You must configure a PersistentCollection namespace. See docs for details');
    }

    public static function invalidParameterTypeHint(
        string $className,
        string $methodName,
        string $parameterName,
        ?Throwable $previous = null
    ) : self {
        return new self(
            sprintf(
                'The type hint of parameter "%s" in method "%s" in class "%s" is invalid.',
                $parameterName,
                $methodName,
                $className
            ),
            0,
            $previous
        );
    }

    public static function invalidReturnTypeHint(string $className, string $methodName, ?Throwable $previous = null) : self
    {
        return new self(
            sprintf(
                'The return type of method "%s" in class "%s" is invalid.',
                $methodName,
                $className
            ),
            0,
            $previous
        );
    }

    public static function parentClassRequired(string $className, string $methodName) : self
    {
        return new self(
            sprintf(
                'The method "%s" in class "%s" defines a parent return type, but the class does not extend any class.',
                $methodName,
                $className
            )
        );
    }

    public static function ownerRequiredToLoadCollection() : self
    {
        return new self('Cannot load persistent collection without an owner.');
    }
}