ORMException::invalidOrientation() - Code Metrics - Inspection of "Remove unused exceptions" - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#7008)

by Grégoire

created 2018-01-24 19:29 UTC

ORMException::invalidOrientation() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php

declare(strict_types=1);

namespace Doctrine\ORM;

use Doctrine\Common\Cache\Cache as CacheDriver;
use Exception;

/**
 * Base exception class for all ORM exceptions.
 */
class ORMException extends Exception
{
    /**
     * @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().');
    }

    /**
     * @param string $queryName
     *
     * @return ORMException
     */
    public static function namedQueryNotFound($queryName)
    {
        return new self('Could not find a named query by the name "' . $queryName . '"');
    }

    /**
     * @param string $nativeQueryName
     *
     * @return ORMException
     */
    public static function namedNativeQueryNotFound($nativeQueryName)
    {
        return new self('Could not find a named native query by the name "' . $nativeQueryName . '"');
    }

     * @param string $field
class A {
    var $property;
}
     *
     * @return ORMException
     */
    public static function unrecognizedField($field)
    {
        return new self('Unrecognized field: ' . $field);
    }

    /**
     * @param string $class
     * @param string $association
     * @param string $given
     * @param string $expected
     *
     * @return \Doctrine\ORM\ORMInvalidArgumentException
     */
    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));
    }

    /**
     * @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);
    }

    /**
     * @return ORMException
     */
    public static function entityManagerClosed()
    {
        return new self('The EntityManager is closed.');
    }

    /**
     * @param string $mode
     *
     * @return ORMException
     */
    public static function invalidHydrationMode($mode)
    {
        return new self(sprintf("'%s' is an invalid hydration mode.", $mode));
    }

    /**
     * @return ORMException
     */
    public static function mismatchedEventManager()
    {
        return new self('Cannot use different EventManager instances for EntityManager and Connection.');
    }

    /**
     * @param string $methodName
     *
     * @return ORMException
     */
    public static function findByRequiresParameter($methodName)
    {
        return new self("You need to pass a parameter to '" . $methodName . "'");
    }

    /**
     * @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"
        );
    }

    /**
     * @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.'
        );
    }

    /**
     * @return ORMException
     */
    public static function invalidResultCacheDriver()
    {
        return new self('Invalid result cache driver; it must implement Doctrine\\Common\\Cache\\Cache.');
    }

    /**
     * @return ORMException
     */
    public static function notSupported()
    {
        return new self('This behaviour is (currently) not supported by Doctrine 2');
    }

    /**
     * @return ORMException
     */
    public static function queryCacheNotConfigured()
    {
        return new self('Query Cache is not configured.');
    }

    /**
     * @return ORMException
     */
    public static function metadataCacheNotConfigured()
    {
        return new self('Class Metadata Cache is not configured.');
    }

    /**
     * @return ORMException
     */
    public static function queryCacheUsesNonPersistentCache(CacheDriver $cache)
    {
        return new self('Query Cache uses a non-persistent cache driver, ' . get_class($cache) . '.');
    }

    /**
     * @return ORMException
     */
    public static function metadataCacheUsesNonPersistentCache(CacheDriver $cache)
    {
        return new self('Metadata Cache uses a non-persistent cache driver, ' . get_class($cache) . '.');
    }

    /**
     * @return ORMException
     */
    public static function proxyClassesAlwaysRegenerating()
    {
        return new self('Proxy Classes are always regenerating.');
    }

    /**
     * @param string $className
     *
     * @return ORMException
     */
    public static function invalidEntityRepository($className)
    {
        return new self("Invalid repository class '" . $className . "'. It must be a Doctrine\Common\Persistence\ObjectRepository.");
    }

    /**
     * @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));
    }

    /**
     * @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 . "'."
        );
    }

    /**
     * @return ORMException
     */
    public static function cantUseInOperatorOnCompositeKeys()
    {
        return new self("Can't use IN operator on entities that have composite keys.");
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Doctrine\ORM;
6
7			use Doctrine\Common\Cache\Cache as CacheDriver;
8			use Exception;
9
10			/**
11			* Base exception class for all ORM exceptions.
12			*/
13			class ORMException extends Exception
14			{
15			/**
16			* @return ORMException
17			*/
18			public static function missingMappingDriverImpl()
19			{
20			return new self("It's a requirement to specify a Metadata Driver and pass it " .
21			'to Doctrine\\ORM\\Configuration::setMetadataDriverImpl().');
22			}
23
24			/**
25			* @param string $queryName
26			*
27			* @return ORMException
28			*/
29			public static function namedQueryNotFound($queryName)
30			{
31			return new self('Could not find a named query by the name "' . $queryName . '"');
32			}
33
34			/**
35			* @param string $nativeQueryName
36			*
37			* @return ORMException
38			*/
39			public static function namedNativeQueryNotFound($nativeQueryName)
40			{
41			return new self('Could not find a named native query by the name "' . $nativeQueryName . '"');
42			}
43
44			* @param string $field
			0 ignored issues – show Bug introduced 2018-01-24 19:42 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected '*', expecting T_FUNCTION or T_CONST on line 44 at column 5 Loading history... Coding Style introduced 2018-01-24 19:42 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history... Coding Style introduced 2018-01-24 19:42 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$field`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
45			*
46			* @return ORMException
47			*/
48			public static function unrecognizedField($field)
49			{
50			return new self('Unrecognized field: ' . $field);
51			}
52
53			/**
54			* @param string $class
55			* @param string $association
56			* @param string $given
57			* @param string $expected
58			*
59			* @return \Doctrine\ORM\ORMInvalidArgumentException
60			*/
61			public static function unexpectedAssociationValue($class, $association, $given, $expected)
62			{
63			return new self(sprintf('Found entity of type %s on association %s#%s, but expecting %s', $given, $class, $association, $expected));
64			}
65
66			/**
67			* @param string $className
68			* @param string $field
69			*
70			* @return ORMException
71			*/
72			public static function invalidOrientation($className, $field)
73			{
74			return new self('Invalid order by orientation specified for ' . $className . '#' . $field);
75			}
76
77			/**
78			* @return ORMException
79			*/
80			public static function entityManagerClosed()
81			{
82			return new self('The EntityManager is closed.');
83			}
84
85			/**
86			* @param string $mode
87			*
88			* @return ORMException
89			*/
90			public static function invalidHydrationMode($mode)
91			{
92			return new self(sprintf("'%s' is an invalid hydration mode.", $mode));
93			}
94
95			/**
96			* @return ORMException
97			*/
98			public static function mismatchedEventManager()
99			{
100			return new self('Cannot use different EventManager instances for EntityManager and Connection.');
101			}
102
103			/**
104			* @param string $methodName
105			*
106			* @return ORMException
107			*/
108			public static function findByRequiresParameter($methodName)
109			{
110			return new self("You need to pass a parameter to '" . $methodName . "'");
111			}
112
113			/**
114			* @param string $entityName
115			* @param string $fieldName
116			* @param string $method
117			*
118			* @return ORMException
119			*/
120			public static function invalidMagicCall($entityName, $fieldName, $method)
121			{
122			return new self(
123			"Entity '" . $entityName . "' has no field '" . $fieldName . "'. " .
124			"You can therefore not call '" . $method . "' on the entities' repository"
125			);
126			}
127
128			/**
129			* @param string $entityName
130			* @param string $associationFieldName
131			*
132			* @return ORMException
133			*/
134			public static function invalidFindByInverseAssociation($entityName, $associationFieldName)
135			{
136			return new self(
137			"You cannot search for the association field '" . $entityName . '#' . $associationFieldName . "', " .
138			'because it is the inverse side of an association. Find methods only work on owning side associations.'
139			);
140			}
141
142			/**
143			* @return ORMException
144			*/
145			public static function invalidResultCacheDriver()
146			{
147			return new self('Invalid result cache driver; it must implement Doctrine\\Common\\Cache\\Cache.');
148			}
149
150			/**
151			* @return ORMException
152			*/
153			public static function notSupported()
154			{
155			return new self('This behaviour is (currently) not supported by Doctrine 2');
156			}
157
158			/**
159			* @return ORMException
160			*/
161			public static function queryCacheNotConfigured()
162			{
163			return new self('Query Cache is not configured.');
164			}
165
166			/**
167			* @return ORMException
168			*/
169			public static function metadataCacheNotConfigured()
170			{
171			return new self('Class Metadata Cache is not configured.');
172			}
173
174			/**
175			* @return ORMException
176			*/
177			public static function queryCacheUsesNonPersistentCache(CacheDriver $cache)
178			{
179			return new self('Query Cache uses a non-persistent cache driver, ' . get_class($cache) . '.');
180			}
181
182			/**
183			* @return ORMException
184			*/
185			public static function metadataCacheUsesNonPersistentCache(CacheDriver $cache)
186			{
187			return new self('Metadata Cache uses a non-persistent cache driver, ' . get_class($cache) . '.');
188			}
189
190			/**
191			* @return ORMException
192			*/
193			public static function proxyClassesAlwaysRegenerating()
194			{
195			return new self('Proxy Classes are always regenerating.');
196			}
197
198			/**
199			* @param string $className
200			*
201			* @return ORMException
202			*/
203			public static function invalidEntityRepository($className)
204			{
205			return new self("Invalid repository class '" . $className . "'. It must be a Doctrine\Common\Persistence\ObjectRepository.");
206			}
207
208			/**
209			* @param string $className
210			* @param string $fieldName
211			*
212			* @return ORMException
213			*/
214			public static function missingIdentifierField($className, $fieldName)
215			{
216			return new self(sprintf('The identifier %s is missing for a query of %s', $fieldName, $className));
217			}
218
219			/**
220			* @param string $className
221			* @param string[] $fieldNames
222			*
223			* @return ORMException
224			*/
225			public static function unrecognizedIdentifierFields($className, $fieldNames)
226			{
227			return new self(
228			"Unrecognized identifier fields: '" . implode("', '", $fieldNames) . "' " .
229			"are not present on class '" . $className . "'."
230			);
231			}
232
233			/**
234			* @return ORMException
235			*/
236			public static function cantUseInOperatorOnCompositeKeys()
237			{
238			return new self("Can't use IN operator on entities that have composite keys.");
239			}
240			}
241

doctrine / orm

Pull Request — master (#7008)

ORMException::invalidOrientation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like