Vectorface\SnappyRouter\Handler\AbstractRequestHandler

Complexity

Total Complexity

3

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	2	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
	isAppropriate()	0	1	?
	getRequest()	0	1	?
A	handleException()	0	9	2
A	isCliHandler()	0	4	1

<?php

namespace Vectorface\SnappyRouter\Handler;

use \Exception;
use Vectorface\SnappyRouter\Exception\RouterExceptionInterface;
use Vectorface\SnappyRouter\Response\AbstractResponse;

/**
 * The base class for all handlers that implement a request/response style of
 * invokation.
 * @copyright Copyright (c) 2014, VectorFace, Inc.
 * @author Dan Bruce <dbruce@vectorface.com>
 */
abstract class AbstractRequestHandler extends AbstractHandler
{
    /**
     * Returns true if the handler determines it should handle this request and false otherwise.
     * @param string $path The URL path for the request.
     * @param array $query The query parameters.
     * @param array $post The post data.
     * @param string $verb The HTTP verb used in the request.
     * @return boolean Returns true if this handler will handle the request and false otherwise.
     */
    abstract public function isAppropriate($path, $query, $post, $verb);

    /**
     * Returns a request object extracted from the request details (path, query, etc). The method
     * isAppropriate() must have returned true, otherwise this method should return null.
     * @return \Vectorface\SnappyRouter\Request\HttpRequest|null Returns a
     *         Request object or null if this handler is not appropriate.
     */
    abstract public function getRequest();

    /**
     * Provides the handler with an opportunity to perform any last minute
     * error handling logic. The returned value will be serialized by the
     * handler's encoder.
     * @param Exception $e The exception that was thrown.
     * @return mixed Returns a serializable value that will be encoded and returned
     *         to the client.
     */
    public function handleException(Exception $e)
    {
        $responseCode = AbstractResponse::RESPONSE_SERVER_ERROR;
        if ($e instanceof RouterExceptionInterface) {
            $responseCode = $e->getAssociatedStatusCode();
        }
        \Vectorface\SnappyRouter\http_response_code($responseCode);
        return parent::handleException($e);
    }

    /**
     * Returns whether a handler should function in a CLI environment.
     * @return bool Returns true if the handler should function in a CLI
     *         environment and false otherwise.
     */
    public function isCliHandler()
    {
        return false;
    }
}