<?php

declare(strict_types=1);

namespace Doctrine\ORM;

use Doctrine\Common\Cache\Cache as CacheDriver;

use Doctrine\Persistence\ObjectRepository;

use Exception;

use function get_debug_type;

use function implode;

use function sprintf;

/**

* Base exception class for all ORM exceptions.

*

* @deprecated Use Doctrine\ORM\Exception\ORMException for catch and instanceof

*/

class ORMException extends Exception

{

/**

* @deprecated Use Doctrine\ORM\Exception\MissingMappingDriverImplementation

*

* @return ORMException

*/

public static function missingMappingDriverImpl()

{

return new self("It's a requirement to specify a Metadata Driver and pass it " .

'to Doctrine\\ORM\\Configuration::setMetadataDriverImpl().');

}

/**

* @deprecated Use Doctrine\ORM\Exception\NamedQueryNotFound

*

* @param string $queryName

*

* @return ORMException

*/

public static function namedQueryNotFound($queryName)

{

return new self('Could not find a named query by the name "' . $queryName . '"');

}

/**

* @deprecated Use Doctrine\ORM\Exception\NamedQueryNotFound

*

* @param string $nativeQueryName

*

* @return ORMException

*/

public static function namedNativeQueryNotFound($nativeQueryName)

{

return new self('Could not find a named native query by the name "' . $nativeQueryName . '"');

}

/**

* @deprecated Use Doctrine\ORM\Persisters\Exception\UnrecognizedField

*

* @param string $field

*

* @return ORMException

*/

public static function unrecognizedField($field)

{

return new self(sprintf('Unrecognized field: %s', $field));

}

/**

* @deprecated Use Doctrine\ORM\Exception\UnexpectedAssociationValue

*

* @param string $class

* @param string $association

* @param string $given

* @param string $expected

*

* @return ORMException

*/

public static function unexpectedAssociationValue($class, $association, $given, $expected)

{

return new self(sprintf('Found entity of type %s on association %s#%s, but expecting %s', $given, $class, $association, $expected));

}

/**

* @deprecated Use Doctrine\ORM\Persisters\Exception\InvalidOrientation

*

* @param string $className

* @param string $field

*

* @return ORMException

*/

public static function invalidOrientation($className, $field)

{

return new self('Invalid order by orientation specified for ' . $className . '#' . $field);

}

/**

* @deprecated Use Doctrine\ORM\Exception\EntityManagerClosed

*

* @return ORMException

*/

public static function entityManagerClosed()

{

return new self('The EntityManager is closed.');

}

/**

* @deprecated Use Doctrine\ORM\Exception\InvalidHydrationMode

*

* @param string $mode

*

* @return ORMException

*/

public static function invalidHydrationMode($mode)

{

return new self(sprintf("'%s' is an invalid hydration mode.", $mode));

}

/**

* @deprecated Use Doctrine\ORM\Exception\MismatchedEventManager

*

* @return ORMException

*/

public static function mismatchedEventManager()

{

return new self('Cannot use different EventManager instances for EntityManager and Connection.');

}

/**

* @deprecated Use Doctrine\ORM\Repository\Exception\InvalidMagicMethodCall::onMissingParameter()

*

* @param string $methodName

*

* @return ORMException

*/

public static function findByRequiresParameter($methodName)

{

return new self("You need to pass a parameter to '" . $methodName . "'");

}

/**

* @deprecated Doctrine\ORM\Repository\Exception\InvalidFindByCall

*

* @param string $entityName

* @param string $fieldName

* @param string $method

*

* @return ORMException

*/

public static function invalidMagicCall($entityName, $fieldName, $method)

{

return new self(

"Entity '" . $entityName . "' has no field '" . $fieldName . "'. " .

"You can therefore not call '" . $method . "' on the entities' repository"

);

}

/**

* @deprecated Use Doctrine\ORM\Repository\Exception\InvalidFindByCall::fromInverseSideUsage()

*

* @param string $entityName

* @param string $associationFieldName

*

* @return ORMException

*/

public static function invalidFindByInverseAssociation($entityName, $associationFieldName)

{

return new self(

"You cannot search for the association field '" . $entityName . '#' . $associationFieldName . "', " .

'because it is the inverse side of an association. Find methods only work on owning side associations.'

);

}

/**

* @deprecated Use Doctrine\ORM\Cache\Exception\InvalidResultCacheDriver

*

* @return ORMException

*/

public static function invalidResultCacheDriver()

{

return new self('Invalid result cache driver; it must implement Doctrine\\Common\\Cache\\Cache.');

}

/**

* @deprecated Doctrine\ORM\Tools\Exception\NotSupported

*

* @return ORMException

*/

public static function notSupported()

{

return new self('This behaviour is (currently) not supported by Doctrine 2');

}

/**

* @deprecated Use Doctrine\ORM\Cache\Exception\QueryCacheNotConfigured

*

* @return ORMException

*/

public static function queryCacheNotConfigured()

{

return new self('Query Cache is not configured.');

}

/**

* @deprecated Use Doctrine\ORM\Cache\Exception\MetadataCacheNotConfigured

*

* @return ORMException

*/

public static function metadataCacheNotConfigured()

{

return new self('Class Metadata Cache is not configured.');

}

/**

* @deprecated Use Doctrine\ORM\Cache\Exception\QueryCacheUsesNonPersistentCache

*

* @return ORMException

*/

public static function queryCacheUsesNonPersistentCache(CacheDriver $cache)

{

return new self('Query Cache uses a non-persistent cache driver, ' . get_debug_type($cache) . '.');

}

/**

* @deprecated Use Doctrine\ORM\Cache\Exception\MetadataCacheUsesNonPersistentCache

*

* @return ORMException

*/

public static function metadataCacheUsesNonPersistentCache(CacheDriver $cache)

{

return new self('Metadata Cache uses a non-persistent cache driver, ' . get_debug_type($cache) . '.');

}

/**

* @deprecated Use Doctrine\ORM\Exception\ProxyClassesAlwaysRegenerating

*

* @return ORMException

*/

public static function proxyClassesAlwaysRegenerating()

{

return new self('Proxy Classes are always regenerating.');

}

/**

* @deprecated Use Doctrine\ORM\Exception\UnknownEntityNamespace

*

* @param string $entityNamespaceAlias

*

* @return ORMException

*/

public static function unknownEntityNamespace($entityNamespaceAlias)

{

return new self(

sprintf("Unknown Entity namespace alias '%s'.", $entityNamespaceAlias)

);

}

/**

* @deprecated Use Doctrine\ORM\Exception\InvalidEntityRepository

*

* @param string $className

*

* @return ORMException

*/

public static function invalidEntityRepository($className)

{

return new self(sprintf(

"Invalid repository class '%s'. It must be a %s.",

$className,

ObjectRepository::class

));

}

/**

* @deprecated Use Doctrine\ORM\Exception\MissingIdentifierField

*

* @param string $className

* @param string $fieldName

*

* @return ORMException

*/

public static function missingIdentifierField($className, $fieldName)

{

return new self(sprintf('The identifier %s is missing for a query of %s', $fieldName, $className));

}

/**

* @deprecated Use Doctrine\ORM\Exception\UnrecognizedIdentifierFields

*

* @param string $className

* @param string[] $fieldNames

*

* @return ORMException

*/

public static function unrecognizedIdentifierFields($className, $fieldNames)

{

return new self(

"Unrecognized identifier fields: '" . implode("', '", $fieldNames) . "' " .

"are not present on class '" . $className . "'."

);

}

/**

* @deprecated Use Doctrine\ORM\Persisters\Exception\CantUseInOperatorOnCompositeKeys

*

* @return ORMException

*/

public static function cantUseInOperatorOnCompositeKeys()

{

return new self("Can't use IN operator on entities that have composite keys.");

}

}