Drest\DrestException

Complexity

Total Complexity

24

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

64.29%

Importance

Changes	16
Bugs	0	Features	2

24 Methods

Rating	Name	Duplication	Size	Complexity
A	basePathMustBeAString()	0	4	1
A	metadataCacheNotConfigured()	0	6	1
A	currentlyRunningDebugMode()	0	6	1
A	annotatedResourceRequiresAtLeastOneServiceDefinition()	0	6	1
A	routeAlreadyDefinedWithName()	0	5	1
A	routeNameIsEmpty()	0	5	1
A	invalidHttpVerbUsed()	0	5	1
A	unknownDetectContentOption()	0	5	1
A	pathToConfigFilesRequired()	0	5	1
A	unableToLoadMetaDataFromDriver()	0	5	1
A	invalidExposeRelationFetchType()	0	6	1
A	unknownExposeRequestOption()	0	6	1
A	handleAlreadyDefinedForRoute()	0	6	1
A	handleForGetRouteMustBeStatic()	0	4	1
A	handleAnnotationDoesntMatchRouteName()	0	6	1
A	routeRequiresHandle()	0	6	1
A	handleForCannotBeEmpty()	0	4	1
A	invalidNamedRouteSyntax()	0	6	1
A	unableToFindRouteByName()	0	5	1
A	resourceCanOnlyHaveOneRouteSetAsOrigin()	0	4	1
A	unableToHandleACollectionPush()	0	6	1
A	actionClassNotAnInstanceOfActionAbstract()	0	5	1
A	unknownActionClass()	0	4	1
A	noMatchedRouteSet()	0	6	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');
    }
}