RouteHandler::setDefaultOutput() - Code Metrics - Inspection of "Merge branch 'pre11'" - byjg/restserver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 066784...351105 )

by Joao

created 2016-01-20 19:12 UTC

RouteHandler::setDefaultOutput() A

↳ Parent: RouteHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace ByJG\RestServer;

use BadMethodCallException;
use ByJG\RestServer\ErrorHandler;
use ByJG\RestServer\Exception\ClassNotFoundException;
use ByJG\RestServer\Exception\Error404Exception;
use ByJG\RestServer\Exception\Error405Exception;
use ByJG\RestServer\Exception\InvalidClassException;
use ByJG\RestServer\HandlerInterface;
use ByJG\RestServer\Output;
use ByJG\RestServer\RouteHandler;
use ByJG\RestServer\ServiceAbstract;
use FastRoute\Dispatcher;
use FastRoute\RouteCollector;
use InvalidArgumentException;

class RouteHandler
{

    use \ByJG\DesignPattern\Singleton;

    const OK = "OK";
    const METHOD_NOT_ALLOWED = "NOT_ALLOWED";
    const NOT_FOUND = "NOT FOUND";

    protected $_defaultMethods = [
        // Service
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}/{secondid}.{output}' ],
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}.{output}' ],
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{id:[0-9]+}/{action}.{output}' ],
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{id:[0-9]+}.{output}' ],
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}.{output}' ],
        [ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}.{output}' ]
    ];
    protected $_moduleAlias = [];
    protected $_defaultRestVersion = '1.0';
    protected $_defaultHandler = '\ByJG\RestServer\ServiceHandler';
    protected $_defaultOutput = null;

    public function getDefaultMethods()
    {
        return $this->_defaultMethods;
    }

    public function setDefaultMethods($methods)
    {
        if (!is_array($methods)) {
            throw new InvalidArgumentException('You need pass an array');
        }

        foreach ($methods as $value) {
            if (!isset($value['method']) || !isset($value['pattern'])) {
                throw new InvalidArgumentException('Array has not the valid format');
            }
        }

        $this->_defaultMethods = $methods;
    }

    public function getDefaultRestVersion()
    {
        return $this->_defaultRestVersion;
    }

    public function setDefaultRestVersion($version)
    {
        $this->_defaultRestVersion = $version;
    }

    public function getDefaultHandler()
    {
        return $this->_defaultHandler;
    }

    public function setDefaultHandler($value)
    {
        $this->_defaultHandler = $value;
    }

    public function getDefaultOutput()
    {
        return empty($this->_defaultOutput) ? Output::JSON : $this->_defaultOutput;
    }

    public function setDefaultOutput($defaultOutput)
    {
        $this->_defaultOutput = $defaultOutput;
    }

    public function getModuleAlias()
    {
        return $this->_moduleAlias;
    }

    public function addModuleAlias($alias, $module)
    {
        $this->_moduleAlias[$alias] = $module;
    }

    public function process()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Initialize ErrorHandler with default error handler
        ErrorHandler::getInstance()->register();

        // Get the URL parameters
        $httpMethod = $_SERVER['REQUEST_METHOD'];
        $uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
        parse_str(parse_url($_SERVER['REQUEST_URI'], PHP_URL_QUERY), $queryStr);

        // Generic Dispatcher for RestServer
        $dispatcher = \FastRoute\simpleDispatcher(function(RouteCollector $r) {

            foreach ($this->getDefaultMethods() as $route) {
                $r->addRoute(
                    $route['method'],
                    str_replace('{version}', $this->getDefaultRestVersion(), $route['pattern']),
                    isset($route['handler']) ? $route['handler'] : $this->getDefaultHandler()
                );
            }
        });

        $routeInfo = $dispatcher->dispatch($httpMethod, $uri);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

        switch ($routeInfo[0]) {
            case Dispatcher::NOT_FOUND:

                throw new Error404Exception('404 Not found');

            case Dispatcher::METHOD_NOT_ALLOWED:

                throw new Error405Exception('405 Method Not Allowed');

            case Dispatcher::FOUND:

                // ... 200 Process:

                $vars = array_merge($routeInfo[2], $queryStr);

                // Check Alias
                $moduleAlias = $this->getModuleAlias();
                if (isset($moduleAlias[$vars['module']])) {
                    $vars['module'] = $moduleAlias[$vars['module']];
                }
                $vars['module'] = '\\' . str_replace('.', '\\', $vars['module']);

                // Define output
                if (!isset($vars['output'])) {
                    $vars['output'] = $this->getDefaultOutput();
                }
                ErrorHandler::getInstance()->setHandler($vars['output']);

                // Set all default values
                foreach ($vars as $key => $value) {
                    $_REQUEST[$key] = $_GET[$key] = $vars[$key];
                }

                // Instantiate the Service Handler
                $handlerInstance = $this->getHandler($routeInfo[1], $vars['output']);
                $instance = $this->executeAction($vars['module']);

                echo $handlerInstance->execute($instance);
                break;

            default:
                throw new Exception('Unknown');
        }
    }

    /**
     * Get the Handler based on the string
     *
     * @param string $handler
     * @param string $output
     * @throws ClassNotFoundException
     * @throws InvalidClassException
     * @return HandlerInterface Return the Handler Interface
     */
    public function getHandler($handler, $output)
    {
        if (!class_exists($handler)) {
            throw new ClassNotFoundException("Handler $handler not found");
        }
        $handlerInstance = new $handler();
        if (!($handlerInstance instanceof HandlerInterface)) {
            throw new InvalidClassException("Handler $handler is not a HandlerInterface");
        }
        $handlerInstance->setOutput($output);
        $handlerInstance->setHeader();

        return $handlerInstance;
    }

    /**
     * Instantiate the class found in the route
     *
     * @param string $class
     * @return ServiceAbstract
     * @throws ClassNotFoundException
     * @throws InvalidClassException
     * @throws BadMethodCallException
     */
    public function executeAction($class)
    {
        // Instantiate a new class
        if (!class_exists($class)) {
            throw new ClassNotFoundException("Class $class not found");
        }
        $instance = new $class();

        if (!($instance instanceof ServiceAbstract)) {
            throw new InvalidClassException("Class $class is not an instance of ServiceAbstract");
        }

        // Execute the method
        $method = strtolower($instance->getRequest()->server("REQUEST_METHOD")); // get, post, put, delete
        $customAction = $method . ($instance->getRequest()->get('action'));
        if (method_exists($instance, $customAction)) {
            $instance->$customAction();
        } else {
            throw new BadMethodCallException("The method '$customAction' does not exists.");
        }

        return $instance;
    }

    /**
     * Process the ROUTE (see httpdocs/route-dist.php)
     *
     * ModuleAlias needs to be an array like:
     *  [ 'alias' => 'Full.Namespace.To.Class' ]
     *
     * RoutePattern needs to be an array like:
     * [
     *     [
     *         "method" => ['GET'],
     *         "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}/{secondid}.{output}',
     *         "handler" => '\ByJG\RestServer\ServiceHandler'
     *    ],
     * ]
     *
     * @param array $moduleAlias
     * @param array $routePattern
     * @param string $version
     * @param string $routeIndex
     */
    public static function handleRoute($moduleAlias = [], $routePattern = null, $version = '1.0', $routeIndex = "index.php")
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        ob_start();
        session_start();

        /**
         * @var RouteHandler
         */
        $route = RouteHandler::getInstance();

        /**
         * Module Alias contains the alias for full namespace class.
         *
         * For example, instead to request:
         * http://somehost/module/Full.NameSpace.To.Module
         *
         * you can request only:
         * http://somehost/module/somealias
         */
        foreach ((array) $moduleAlias as $alias => $module) {
            $route->addModuleAlias($alias, $module);
        }

        /**
         * You can create RESTFul compliant URL by adding the version.
         *
         * In the route pattern:
         * /{version}/someurl
         *
         * Setting the value here XMLNuke route will automatically replace it.
         *
         * The default value is "1.0"
         */
        $route->setDefaultRestVersion($version);

        /**
         * There are a couple of basic routes pattern for the default parameters
         *
         * e.g.
         *
         * /1.0/command/1.json
         * /1.0/command/1.xml
         *
         * You can create your own route pattern by define the methods here
         */
        if (!empty($routePattern)) {
            $route->setDefaultMethods($routePattern);
        }

        // --------------------------------------------------------------------------
        // You do not need change from this point
        // --------------------------------------------------------------------------

        if (!empty($_SERVER['SCRIPT_FILENAME'])
            && file_exists($_SERVER['SCRIPT_FILENAME'])
            && basename($_SERVER['SCRIPT_FILENAME']) !== "route.php"
            && basename($_SERVER['SCRIPT_FILENAME']) !== $routeIndex
        )  {
            $file = $_SERVER['SCRIPT_FILENAME'];
            if (strpos($file, '.php') !== false) {
                require_once($file);
            } else {
                header("Content-Type: " . RouteHandler::mimeContentType($file));

                echo file_get_contents($file);
            }
            return;
        }

        $route->process();
    }

    /**
     * Get the Mime Type based on the filename
     *
     * @param string $filename
     * @return string
     */
    protected static function mimeContentType($filename)
    {

        $mime_types = array(
            'txt' => 'text/plain',
            'htm' => 'text/html',
            'html' => 'text/html',
            'php' => 'text/html',
            'css' => 'text/css',
            'js' => 'application/javascript',
            'json' => 'application/json',
            'xml' => 'application/xml',
            'swf' => 'application/x-shockwave-flash',
            'flv' => 'video/x-flv',
            // images
            'png' => 'image/png',
            'jpe' => 'image/jpeg',
            'jpeg' => 'image/jpeg',
            'jpg' => 'image/jpeg',
            'gif' => 'image/gif',
            'bmp' => 'image/bmp',
            'ico' => 'image/vnd.microsoft.icon',
            'tiff' => 'image/tiff',
            'tif' => 'image/tiff',
            'svg' => 'image/svg+xml',
            'svgz' => 'image/svg+xml',
            // archives
            'zip' => 'application/zip',
            'rar' => 'application/x-rar-compressed',
            'exe' => 'application/x-msdownload',
            'msi' => 'application/x-msdownload',
            'cab' => 'application/vnd.ms-cab-compressed',
            // audio/video
            'mp3' => 'audio/mpeg',
            'qt' => 'video/quicktime',
            'mov' => 'video/quicktime',
            // adobe
            'pdf' => 'application/pdf',
            'psd' => 'image/vnd.adobe.photoshop',
            'ai' => 'application/postscript',
            'eps' => 'application/postscript',
            'ps' => 'application/postscript',
            // ms office
            'doc' => 'application/msword',
            'rtf' => 'application/rtf',
            'xls' => 'application/vnd.ms-excel',
            'ppt' => 'application/vnd.ms-powerpoint',
            // open office
            'odt' => 'application/vnd.oasis.opendocument.text',
            'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
        );

        $ext = strtolower(array_pop(explode('.', $filename)));

        if (array_key_exists($ext, $mime_types)) {
            return $mime_types[$ext];
        } elseif (function_exists('finfo_open')) {
            $finfo = finfo_open(FILEINFO_MIME);
            $mimetype = finfo_file($finfo, $filename);
            finfo_close($finfo);
            return $mimetype;
        } else {
            return 'application/octet-stream';
        }
    }
}


1			<?php
2
3			namespace ByJG\RestServer;
4
5			use BadMethodCallException;
6			use ByJG\RestServer\ErrorHandler;
7			use ByJG\RestServer\Exception\ClassNotFoundException;
8			use ByJG\RestServer\Exception\Error404Exception;
9			use ByJG\RestServer\Exception\Error405Exception;
10			use ByJG\RestServer\Exception\InvalidClassException;
11			use ByJG\RestServer\HandlerInterface;
12			use ByJG\RestServer\Output;
13			use ByJG\RestServer\RouteHandler;
14			use ByJG\RestServer\ServiceAbstract;
15			use FastRoute\Dispatcher;
16			use FastRoute\RouteCollector;
17			use InvalidArgumentException;
18
19			class RouteHandler
20			{
21
22			use \ByJG\DesignPattern\Singleton;
23
24			const OK = "OK";
25			const METHOD_NOT_ALLOWED = "NOT_ALLOWED";
26			const NOT_FOUND = "NOT FOUND";
27
28			protected $_defaultMethods = [
29			// Service
30			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}/{secondid}.{output}' ],
31			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}.{output}' ],
32			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{id:[0-9]+}/{action}.{output}' ],
33			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{id:[0-9]+}.{output}' ],
34			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}/{action}.{output}' ],
35			[ "method" => ['GET', 'POST', 'PUT', 'DELETE'], "pattern" => '/{version}/{module}.{output}' ]
36			];
37			protected $_moduleAlias = [];
38			protected $_defaultRestVersion = '1.0';
39			protected $_defaultHandler = '\ByJG\RestServer\ServiceHandler';
40			protected $_defaultOutput = null;
41
42			public function getDefaultMethods()
43			{
44			return $this->_defaultMethods;
45			}
46
47			public function setDefaultMethods($methods)
48			{
49			if (!is_array($methods)) {
50			throw new InvalidArgumentException('You need pass an array');
51			}
52
53			foreach ($methods as $value) {
54			if (!isset($value['method']) \|\| !isset($value['pattern'])) {
55			throw new InvalidArgumentException('Array has not the valid format');
56			}
57			}
58
59			$this->_defaultMethods = $methods;
60			}
61
62			public function getDefaultRestVersion()
63			{
64			return $this->_defaultRestVersion;
65			}
66
67			public function setDefaultRestVersion($version)
68			{
69			$this->_defaultRestVersion = $version;
70			}
71
72			public function getDefaultHandler()
73			{
74			return $this->_defaultHandler;
75			}
76
77			public function setDefaultHandler($value)
78			{
79			$this->_defaultHandler = $value;
80			}
81
82			public function getDefaultOutput()
83			{
84			return empty($this->_defaultOutput) ? Output::JSON : $this->_defaultOutput;
85			}
86
87			public function setDefaultOutput($defaultOutput)
88			{
89			$this->_defaultOutput = $defaultOutput;
90			}
91
92			public function getModuleAlias()
93			{
94			return $this->_moduleAlias;
95			}
96
97			public function addModuleAlias($alias, $module)
98			{
99			$this->_moduleAlias[$alias] = $module;
100			}
101
102			public function process()
			0 ignored issues – show Coding Style introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report `process` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report `process` uses the super-global variable `$_REQUEST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report `process` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
103			{
104			// Initialize ErrorHandler with default error handler
105			ErrorHandler::getInstance()->register();
106
107			// Get the URL parameters
108			$httpMethod = $_SERVER['REQUEST_METHOD'];
109			$uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
110			parse_str(parse_url($_SERVER['REQUEST_URI'], PHP_URL_QUERY), $queryStr);
111
112			// Generic Dispatcher for RestServer
113			$dispatcher = \FastRoute\simpleDispatcher(function(RouteCollector $r) {
114
115			foreach ($this->getDefaultMethods() as $route) {
116			$r->addRoute(
117			$route['method'],
118			str_replace('{version}', $this->getDefaultRestVersion(), $route['pattern']),
119			isset($route['handler']) ? $route['handler'] : $this->getDefaultHandler()
120			);
121			}
122			});
123
124			$routeInfo = $dispatcher->dispatch($httpMethod, $uri);
			0 ignored issues – show Security Bug introduced 2016-01-20 19:14 UTC by Report Bug Copy Issue Report It seems like `$uri` defined by `parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)` on line `109` can also be of type `false`; however, `FastRoute\Dispatcher::dispatch()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
125
126			switch ($routeInfo[0]) {
127			case Dispatcher::NOT_FOUND:
128
129			throw new Error404Exception('404 Not found');
130
131			case Dispatcher::METHOD_NOT_ALLOWED:
132
133			throw new Error405Exception('405 Method Not Allowed');
134
135			case Dispatcher::FOUND:
136
137			// ... 200 Process:
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
138			$vars = array_merge($routeInfo[2], $queryStr);
139
140			// Check Alias
141			$moduleAlias = $this->getModuleAlias();
142			if (isset($moduleAlias[$vars['module']])) {
143			$vars['module'] = $moduleAlias[$vars['module']];
144			}
145			$vars['module'] = '\\' . str_replace('.', '\\', $vars['module']);
146
147			// Define output
148			if (!isset($vars['output'])) {
149			$vars['output'] = $this->getDefaultOutput();
150			}
151			ErrorHandler::getInstance()->setHandler($vars['output']);
152
153			// Set all default values
154			foreach ($vars as $key => $value) {
155			$_REQUEST[$key] = $_GET[$key] = $vars[$key];
156			}
157
158			// Instantiate the Service Handler
159			$handlerInstance = $this->getHandler($routeInfo[1], $vars['output']);
160			$instance = $this->executeAction($vars['module']);
161
162			echo $handlerInstance->execute($instance);
163			break;
164
165			default:
166			throw new Exception('Unknown');
167			}
168			}
169
170			/**
171			* Get the Handler based on the string
172			*
173			* @param string $handler
174			* @param string $output
175			* @throws ClassNotFoundException
176			* @throws InvalidClassException
177			* @return HandlerInterface Return the Handler Interface
178			*/
179			public function getHandler($handler, $output)
180			{
181			if (!class_exists($handler)) {
182			throw new ClassNotFoundException("Handler $handler not found");
183			}
184			$handlerInstance = new $handler();
185			if (!($handlerInstance instanceof HandlerInterface)) {
186			throw new InvalidClassException("Handler $handler is not a HandlerInterface");
187			}
188			$handlerInstance->setOutput($output);
189			$handlerInstance->setHeader();
190
191			return $handlerInstance;
192			}
193
194			/**
195			* Instantiate the class found in the route
196			*
197			* @param string $class
198			* @return ServiceAbstract
199			* @throws ClassNotFoundException
200			* @throws InvalidClassException
201			* @throws BadMethodCallException
202			*/
203			public function executeAction($class)
204			{
205			// Instantiate a new class
206			if (!class_exists($class)) {
207			throw new ClassNotFoundException("Class $class not found");
208			}
209			$instance = new $class();
210
211			if (!($instance instanceof ServiceAbstract)) {
212			throw new InvalidClassException("Class $class is not an instance of ServiceAbstract");
213			}
214
215			// Execute the method
216			$method = strtolower($instance->getRequest()->server("REQUEST_METHOD")); // get, post, put, delete
217			$customAction = $method . ($instance->getRequest()->get('action'));
218			if (method_exists($instance, $customAction)) {
219			$instance->$customAction();
220			} else {
221			throw new BadMethodCallException("The method '$customAction' does not exists.");
222			}
223
224			return $instance;
225			}
226
227			/**
228			* Process the ROUTE (see httpdocs/route-dist.php)
229			*
230			* ModuleAlias needs to be an array like:
231			* [ 'alias' => 'Full.Namespace.To.Class' ]
232			*
233			* RoutePattern needs to be an array like:
234			* [
235			* [
236			* "method" => ['GET'],
237			* "pattern" => '/{version}/{module}/{action}/{id:[0-9]+}/{secondid}.{output}',
238			* "handler" => '\ByJG\RestServer\ServiceHandler'
239			* ],
240			* ]
241			*
242			* @param array $moduleAlias
243			* @param array $routePattern
244			* @param string $version
245			* @param string $routeIndex
246			*/
247			public static function handleRoute($moduleAlias = [], $routePattern = null, $version = '1.0', $routeIndex = "index.php")
			0 ignored issues – show Coding Style introduced 2016-01-20 19:14 UTC by Report Bug Copy Issue Report `handleRoute` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
248			{
249			ob_start();
250			session_start();
251
252			/**
253			* @var RouteHandler
254			*/
255			$route = RouteHandler::getInstance();
256
257			/**
258			* Module Alias contains the alias for full namespace class.
259			*
260			* For example, instead to request:
261			* http://somehost/module/Full.NameSpace.To.Module
262			*
263			* you can request only:
264			* http://somehost/module/somealias
265			*/
266			foreach ((array) $moduleAlias as $alias => $module) {
267			$route->addModuleAlias($alias, $module);
268			}
269
270			/**
271			* You can create RESTFul compliant URL by adding the version.
272			*
273			* In the route pattern:
274			* /{version}/someurl
275			*
276			* Setting the value here XMLNuke route will automatically replace it.
277			*
278			* The default value is "1.0"
279			*/
280			$route->setDefaultRestVersion($version);
281
282			/**
283			* There are a couple of basic routes pattern for the default parameters
284			*
285			* e.g.
286			*
287			* /1.0/command/1.json
288			* /1.0/command/1.xml
289			*
290			* You can create your own route pattern by define the methods here
291			*/
292			if (!empty($routePattern)) {
293			$route->setDefaultMethods($routePattern);
294			}
295
296			// --------------------------------------------------------------------------
297			// You do not need change from this point
298			// --------------------------------------------------------------------------
299
300			if (!empty($_SERVER['SCRIPT_FILENAME'])
301			&& file_exists($_SERVER['SCRIPT_FILENAME'])
302			&& basename($_SERVER['SCRIPT_FILENAME']) !== "route.php"
303			&& basename($_SERVER['SCRIPT_FILENAME']) !== $routeIndex
304			) {
305			$file = $_SERVER['SCRIPT_FILENAME'];
306			if (strpos($file, '.php') !== false) {
307			require_once($file);
308			} else {
309			header("Content-Type: " . RouteHandler::mimeContentType($file));
310
311			echo file_get_contents($file);
312			}
313			return;
314			}
315
316			$route->process();
317			}
318
319			/**
320			* Get the Mime Type based on the filename
321			*
322			* @param string $filename
323			* @return string
324			*/
325			protected static function mimeContentType($filename)
326			{
327
328			$mime_types = array(
329			'txt' => 'text/plain',
330			'htm' => 'text/html',
331			'html' => 'text/html',
332			'php' => 'text/html',
333			'css' => 'text/css',
334			'js' => 'application/javascript',
335			'json' => 'application/json',
336			'xml' => 'application/xml',
337			'swf' => 'application/x-shockwave-flash',
338			'flv' => 'video/x-flv',
339			// images
340			'png' => 'image/png',
341			'jpe' => 'image/jpeg',
342			'jpeg' => 'image/jpeg',
343			'jpg' => 'image/jpeg',
344			'gif' => 'image/gif',
345			'bmp' => 'image/bmp',
346			'ico' => 'image/vnd.microsoft.icon',
347			'tiff' => 'image/tiff',
348			'tif' => 'image/tiff',
349			'svg' => 'image/svg+xml',
350			'svgz' => 'image/svg+xml',
351			// archives
352			'zip' => 'application/zip',
353			'rar' => 'application/x-rar-compressed',
354			'exe' => 'application/x-msdownload',
355			'msi' => 'application/x-msdownload',
356			'cab' => 'application/vnd.ms-cab-compressed',
357			// audio/video
358			'mp3' => 'audio/mpeg',
359			'qt' => 'video/quicktime',
360			'mov' => 'video/quicktime',
361			// adobe
362			'pdf' => 'application/pdf',
363			'psd' => 'image/vnd.adobe.photoshop',
364			'ai' => 'application/postscript',
365			'eps' => 'application/postscript',
366			'ps' => 'application/postscript',
367			// ms office
368			'doc' => 'application/msword',
369			'rtf' => 'application/rtf',
370			'xls' => 'application/vnd.ms-excel',
371			'ppt' => 'application/vnd.ms-powerpoint',
372			// open office
373			'odt' => 'application/vnd.oasis.opendocument.text',
374			'ods' => 'application/vnd.oasis.opendocument.spreadsheet',
375			);
376
377			$ext = strtolower(array_pop(explode('.', $filename)));
			0 ignored issues – show Bug introduced 2016-01-19 16:27 UTC by Report Bug Copy Issue Report `explode('.', $filename)` cannot be passed to `array_pop()` as the parameter `$array` expects a reference. Loading history...
378			if (array_key_exists($ext, $mime_types)) {
379			return $mime_types[$ext];
380			} elseif (function_exists('finfo_open')) {
381			$finfo = finfo_open(FILEINFO_MIME);
382			$mimetype = finfo_file($finfo, $filename);
383			finfo_close($finfo);
384			return $mimetype;
385			} else {
386			return 'application/octet-stream';
387			}
388			}
389			}
390

byjg / restserver

Push — master ( 066784...351105 )

RouteHandler::setDefaultOutput() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like