DrestException::handleForGetRouteMustBeStatic() - Code Metrics - Inspection of "Allow handles to be used on GET routes" - leedavis81/drest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ada7af...87ae84 )

by Lee

created 2016-08-23 15:14 UTC

DrestException::handleForGetRouteMustBeStatic() A

↳ Parent: DrestException

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * This file is part of the Drest package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Lee Davis
 * @copyright Copyright (c) Lee Davis <@leedavis81>
 * @link https://github.com/leedavis81/drest/blob/master/LICENSE
 * @license http://opensource.org/licenses/MIT The MIT X License (MIT)
 */
namespace Drest;

use Exception;

/**
 * Base exception class for all Drest exceptions.
 */
class DrestException extends Exception
{

    // Set up and configuration
    public static function metadataCacheNotConfigured()
    {
        return new self(
            'Class Metadata Cache is not configured, ensure an instance of Doctrine\Common\Cache\Cache' .
            'is passed to the Drest\Configuration::setMetadataCacheImpl()');
    }

    public static function currentlyRunningDebugMode()
    {
        return new self(
            'Debug mode is set to on. This will cause configuration exceptions to be' .
            ' displayed and should be switched off in production');
    }

    public static function annotatedResourceRequiresAtLeastOneServiceDefinition($className)
    {
        return new self(
            'The annotated resource on class ' . $className . ' doesn\'t have any service definitions.' .
            ' Ensure you have "services={@Drest\Service(..)} set');
    }

    public static function routeAlreadyDefinedWithName($class, $name)
    {
        return new self(
            'Route on class ' . $class . ' already exists with the name ' . $name . '. These must be unique');
    }

    public static function routeNameIsEmpty()
    {
        return new self(
            'Route name used cannot be blank, and must only contain alphanumerics or underscore');
    }

    /**
     * @param string $verb
     * @return DrestException
     */
    public static function invalidHttpVerbUsed($verb)
    {
        return new self(
            'Used an unknown HTTP verb of "' . $verb . '"');
    }

    public static function unknownDetectContentOption()
    {
        return new self(
            'Content option used is invalid. Please see DETECT_CONTENT_* options in Drest\Configuration');
    }

    public static function pathToConfigFilesRequired()
    {
        return new self(
            'Path to your configuration files are required for the driver to retrieve all class names');
    }

    public static function unableToLoadMetaDataFromDriver()
    {
        return new self(
            'Unable to load metadata using supplied driver');
    }

    public static function invalidExposeRelationFetchType()
    {
        return new self(
            'Invalid relation fetch type used. ' .
            'Please see Doctrine\ORM\Mapping\ClassMetadataInfo::FETCH_* for available options');
    }

    public static function unknownExposeRequestOption()
    {
        return new self(
            'Unknown expose request option used. ' .
            'Please see EXPOSE_REQUEST_* options in Drest\Configuration');
    }

    public static function basePathMustBeAString()
    {
        return new self('Base path used is invalid. Must be a string');
    }

    public static function handleAlreadyDefinedForRoute(Mapping\RouteMetaData $route)
    {
        return new self(
            'There is a handle already defined for the route '
            . $route->getName() . ' on class ' . $route->getClassMetaData()->getClassName());
    }

    public static function handleForGetRouteMustBeStatic()
    {
        return new self('Any handle used for a get call must be defined as static');
    }

    /**
     * @param string $name
     * @return DrestException
     */
    public static function handleAnnotationDoesntMatchRouteName($name)
    {
        return new self(
            'The configured handle "' . $name . '" doesn\'t match any route of that name. ' .
            'Ensure @Drest\Handle(for="my_route") matches @Drest\Route(name="my_route")');
    }

    /**
     * @param string $name
     * @return DrestException
     */
    public static function routeRequiresHandle($name)
    {
        return new self(
            'Route requires a handle. Ensure a @Drest\Handle(for="' . $name . '") function is set.' .
            ' These are required for all push type routes (POST/PUT/PATCH)');
    }

    public static function handleForCannotBeEmpty()
    {
        return new self('The @Drest\Handle configuration MUST contain a valid / matching "for" value');
    }

    public static function invalidNamedRouteSyntax()
    {
        return new self(
            'Invalid named route syntax. ' .
            'Must use a formatted string of: {EntityClassName}::{RouteName}. Eg "Entities\\User::get_users"');
    }


    /**
     * @param string $routeName
     * @param string $className
     * @return DrestException
     */
    public static function unableToFindRouteByName($routeName, $className)
    {
        return new self(
            'Unable to find the named route "' . $routeName . '" on class ' . $className);
    }

    public static function resourceCanOnlyHaveOneRouteSetAsOrigin()
    {
        return new self('A resource can only have one route set as "origin"');
    }

    public static function unableToHandleACollectionPush()
    {
        return new self(
            'Requests to push data (PUT/POST/PATCH) can only be used on individual elements.' .
            ' Data collections cannot be pushed');
    }

    /**
     * Service Exceptions
     * @param string $class
     * @return DrestException
     */
    public static function actionClassNotAnInstanceOfActionAbstract($class)
    {
        return new self(
            'Action class  "' . $class . '" is not an instance of Drest\Service\Action\ActionAbstract.');
    }

    /**
     * @param string $class
     * @return DrestException
     */
    public static function unknownActionClass($class)
    {
        return new self('Unknown action class "' . $class . '"');
    }

    public static function noMatchedRouteSet()
    {
        return new self(
            'No matched route has been set on this service class.' .
            ' The content type is needed for a default service method call');
    }
}


1		<?php
2		/**
3		* This file is part of the Drest package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*
8		* @author Lee Davis
9		* @copyright Copyright (c) Lee Davis <@leedavis81>
10		* @link https://github.com/leedavis81/drest/blob/master/LICENSE
11		* @license http://opensource.org/licenses/MIT The MIT X License (MIT)
12		*/
13		namespace Drest;
14
15		use Exception;
16
17		/**
18		* Base exception class for all Drest exceptions.
19		*/
20		class DrestException extends Exception
21		{
22
23		// Set up and configuration
24	1	public static function metadataCacheNotConfigured()
25		{
26	1	return new self(
27		'Class Metadata Cache is not configured, ensure an instance of Doctrine\Common\Cache\Cache' .
28	1	'is passed to the Drest\Configuration::setMetadataCacheImpl()');
29		}
30
31	1	public static function currentlyRunningDebugMode()
32		{
33	1	return new self(
34		'Debug mode is set to on. This will cause configuration exceptions to be' .
35	1	' displayed and should be switched off in production');
36		}
37
38	1	public static function annotatedResourceRequiresAtLeastOneServiceDefinition($className)
39		{
40	1	return new self(
41	1	'The annotated resource on class ' . $className . ' doesn\'t have any service definitions.' .
42	1	' Ensure you have "services={@Drest\Service(..)} set');
43		}
44
45	2	public static function routeAlreadyDefinedWithName($class, $name)
46		{
47	2	return new self(
48	2	'Route on class ' . $class . ' already exists with the name ' . $name . '. These must be unique');
49		}
50
51	2	public static function routeNameIsEmpty()
52		{
53	2	return new self(
54	2	'Route name used cannot be blank, and must only contain alphanumerics or underscore');
55		}
56
57		/**
58		* @param string $verb
59		* @return DrestException
60		*/
61	2	public static function invalidHttpVerbUsed($verb)
62		{
63	2	return new self(
64	2	'Used an unknown HTTP verb of "' . $verb . '"');
65		}
66
67	1	public static function unknownDetectContentOption()
68		{
69	1	return new self(
70	1	'Content option used is invalid. Please see DETECT_CONTENT_* options in Drest\Configuration');
71		}
72
73	1	public static function pathToConfigFilesRequired()
74		{
75	1	return new self(
76	1	'Path to your configuration files are required for the driver to retrieve all class names');
77		}
78
79	2	public static function unableToLoadMetaDataFromDriver()
80		{
81	2	return new self(
82	2	'Unable to load metadata using supplied driver');
83		}
84
85	1	public static function invalidExposeRelationFetchType()
86		{
87	1	return new self(
88		'Invalid relation fetch type used. ' .
89	1	'Please see Doctrine\ORM\Mapping\ClassMetadataInfo::FETCH_* for available options');
90		}
91
92	1	public static function unknownExposeRequestOption()
93		{
94	1	return new self(
95		'Unknown expose request option used. ' .
96	1	'Please see EXPOSE_REQUEST_* options in Drest\Configuration');
97		}
98
99	1	public static function basePathMustBeAString()
100		{
101	1	return new self('Base path used is invalid. Must be a string');
102		}
103
104		public static function handleAlreadyDefinedForRoute(Mapping\RouteMetaData $route)
105		{
106		return new self(
107		'There is a handle already defined for the route '
108		. $route->getName() . ' on class ' . $route->getClassMetaData()->getClassName());
109		}
110
111	1	public static function handleForGetRouteMustBeStatic()
112		{
113	1	return new self('Any handle used for a get call must be defined as static');
114		}
115
116		/**
117		* @param string $name
118		* @return DrestException
119		*/
120	1	public static function handleAnnotationDoesntMatchRouteName($name)
121		{
122	1	return new self(
123	1	'The configured handle "' . $name . '" doesn\'t match any route of that name. ' .
124	1	'Ensure @Drest\Handle(for="my_route") matches @Drest\Route(name="my_route")');
125		}
126
127		/**
128		* @param string $name
129		* @return DrestException
130		*/
131		public static function routeRequiresHandle($name)
132		{
133		return new self(
134		'Route requires a handle. Ensure a @Drest\Handle(for="' . $name . '") function is set.' .
135		' These are required for all push type routes (POST/PUT/PATCH)');
136		}
137
138		public static function handleForCannotBeEmpty()
139		{
140		return new self('The @Drest\Handle configuration MUST contain a valid / matching "for" value');
141		}
142
143		public static function invalidNamedRouteSyntax()
144		{
145		return new self(
146		'Invalid named route syntax. ' .
147		'Must use a formatted string of: {EntityClassName}::{RouteName}. Eg "Entities\\User::get_users"');
148		}
149
150
151		/**
152		* @param string $routeName
153		* @param string $className
154		* @return DrestException
155		*/
156	1	public static function unableToFindRouteByName($routeName, $className)
157		{
158	1	return new self(
159	1	'Unable to find the named route "' . $routeName . '" on class ' . $className);
160		}
161
162		public static function resourceCanOnlyHaveOneRouteSetAsOrigin()
163		{
164		return new self('A resource can only have one route set as "origin"');
165		}
166
167		public static function unableToHandleACollectionPush()
168		{
169		return new self(
170		'Requests to push data (PUT/POST/PATCH) can only be used on individual elements.' .
171		' Data collections cannot be pushed');
172		}
173
174		/**
175		* Service Exceptions
176		* @param string $class
177		* @return DrestException
178		*/
179		public static function actionClassNotAnInstanceOfActionAbstract($class)
180		{
181		return new self(
182		'Action class "' . $class . '" is not an instance of Drest\Service\Action\ActionAbstract.');
183		}
184
185		/**
186		* @param string $class
187		* @return DrestException
188		*/
189		public static function unknownActionClass($class)
190		{
191		return new self('Unknown action class "' . $class . '"');
192		}
193
194		public static function noMatchedRouteSet()
195		{
196		return new self(
197		'No matched route has been set on this service class.' .
198		' The content type is needed for a default service method call');
199		}
200		}
201

leedavis81 / drest

Push — master ( ada7af...87ae84 )

DrestException::handleForGetRouteMustBeStatic() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like