CliTaskHandler::performRoute() - Code Metrics - Inspection of "OPTIONS requests no longer output bodies but they..." - Vectorface/SnappyRouter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#13)

unknown

created 2016-08-26 19:40 UTC

CliTaskHandler::performRoute() A

↳ Parent: CliTaskHandler

Complexity

Conditions	3
Paths	3

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3.4746

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	3
eloc	13
c	2
b	0
f	0
nc	3
nop	0
dl	0
loc	22
ccs	10
cts	16
cp	0.625
crap	3.4746
rs	9.2

<?php

namespace Vectorface\SnappyRouter\Handler;

use \Exception;
use Vectorface\SnappyRouter\Exception\ResourceNotFoundException;
use Vectorface\SnappyRouter\Task\TaskInterface;

/**
 * A CLI handler for task/action scripts.
 * @copyright Copyright (c) 2014, VectorFace, Inc.
 * @author Dan Bruce <[email protected]>
 */
class CliTaskHandler extends AbstractCliHandler
{
    /**
     * Determines whether the current handler is appropriate for the given
     * path components.
     * @param array $components The path components as an array.
     * @return boolean Returns true if the handler is appropriate and false
     *         otherwise.
     */
    public function isAppropriate($components)
    {
        $components = array_values(array_filter(array_map('trim', $components), 'strlen'));
        $this->options = array();
        if (count($components) < 5) {
            return false;
        }

        if ($components[1] !== '--task' || $components[3] !== '--action') {
            return false;
        }
        $this->options['task'] = $components[2];
        $this->options['action'] = $components[4];

        try {
            // ensure we have this task registered
            $this->getServiceProvider()->get($this->options['task']);
        } catch (Exception $e) {
            return false;
        }

        return true;
    }

    /**
     * Performs the actual routing.
     * @return mixed Returns the result of the route.
     */
    public function performRoute()
// 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);
    }
}
    {
        $task = $this->getServiceProvider()->getServiceInstance($this->options['task']);
        if (false === method_exists($task, $this->options['action'])) {
            throw new ResourceNotFoundException(
                sprintf(
                    '%s task does not have action %s.',
                    $this->options['task'],
                    $this->options['action']
                )
            );
        }

        // call the task's init function
        if ($task instanceof TaskInterface) {
            $task->init($this->options);
        }

        $taskParams = array_splice($_SERVER['argv'], 5);
        $action = $this->options['action'];
        return $task->$action($taskParams);
    }
}


1		<?php
2
3		namespace Vectorface\SnappyRouter\Handler;
4
5		use \Exception;
6		use Vectorface\SnappyRouter\Exception\ResourceNotFoundException;
7		use Vectorface\SnappyRouter\Task\TaskInterface;
8
9		/**
10		* A CLI handler for task/action scripts.
11		* @copyright Copyright (c) 2014, VectorFace, Inc.
12		* @author Dan Bruce <[email protected]>
13		*/
14		class CliTaskHandler extends AbstractCliHandler
15		{
16		/**
17		* Determines whether the current handler is appropriate for the given
18		* path components.
19		* @param array $components The path components as an array.
20		* @return boolean Returns true if the handler is appropriate and false
21		* otherwise.
22		*/
23	5	public function isAppropriate($components)
24		{
25	5	$components = array_values(array_filter(array_map('trim', $components), 'strlen'));
26	5	$this->options = array();
27	5	if (count($components) < 5) {
28	1	return false;
29		}
30
31	5	if ($components[1] !== '--task' \|\| $components[3] !== '--action') {
32	1	return false;
33		}
34	5	$this->options['task'] = $components[2];
35	5	$this->options['action'] = $components[4];
36
37		try {
38		// ensure we have this task registered
39	5	$this->getServiceProvider()->get($this->options['task']);
40	5	} catch (Exception $e) {
41	3	return false;
42		}
43
44	4	return true;
45		}
46
47		/**
48		* Performs the actual routing.
49		* @return mixed Returns the result of the route.
50		*/
51	1	public function performRoute()
		0 ignored issues – show Coding Style introduced 2016-04-26 14:02 UTC by Report Bug Copy Issue Report `performRoute` 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...
52		{
53	1	$task = $this->getServiceProvider()->getServiceInstance($this->options['task']);
54	1	if (false === method_exists($task, $this->options['action'])) {
55	1	throw new ResourceNotFoundException(
56	1	sprintf(
57	1	'%s task does not have action %s.',
58	1	$this->options['task'],
59	1	$this->options['action']
60	1	)
61	1	);
62		}
63
64		// call the task's init function
65		if ($task instanceof TaskInterface) {
66		$task->init($this->options);
67		}
68
69		$taskParams = array_splice($_SERVER['argv'], 5);
70		$action = $this->options['action'];
71		return $task->$action($taskParams);
72		}
73		}
74

Vectorface / SnappyRouter

Pull Request — master (#13)

CliTaskHandler::performRoute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like