Vectorface\SnappyRouter\Handler\DirectScriptHandler

Complexity

Total Complexity

8

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequest()	0	4	1
A	performRoute()	0	6	1
A	isAppropriate()	0	18	6

<?php

namespace Vectorface\SnappyRouter\Handler;

/**
 * A handler for invoking scripts directly.
 * @copyright Copyright (c) 2014, VectorFace, Inc.
 * @author Dan Bruce <dbruce@vectorface.com>
 */
class DirectScriptHandler extends AbstractRequestHandler
{
    /** Options key for the path mapping array */
    const KEY_PATH_MAP = 'pathMap';

    private $scriptPath;

    /**
     * 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.
     */
    public function isAppropriate($path, $query, $post, $verb)
    {
        $options = $this->getOptions();
        $pathMaps = array();
        if (isset($options[self::KEY_PATH_MAP])) {
            $pathMaps = (array)$options[self::KEY_PATH_MAP];
        }
        foreach ($pathMaps as $pathPrefix => $folder) {
            if (false !== ($pos = strpos($path, $pathPrefix))) {
                $scriptPath = $folder.DIRECTORY_SEPARATOR.substr($path, $pos+strlen($pathPrefix));
                if (file_exists($scriptPath) && is_readable($scriptPath)) {
                    $this->scriptPath = realpath($scriptPath);
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * 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.
     */
    public function getRequest()
    {
        return null;
    }

    /**
     * Performs the actual routing.
     * @return mixed Returns the result of the route.
     */
    public function performRoute()
    {
        $buffer = ob_start();
        require $this->scriptPath;
        return ob_get_clean();
    }
}