Resource::member() - Code Metrics - codeburnerframework/routing - Measure and Improve Code Quality continuously with Scrutinizer

Resource::member() A
last analyzed 2016-02-22 17:31 UTC

↳ Parent: Resource

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	0
cts	5
cp	0
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	2

<?php

/**
 * Codeburner Framework.
 *
 * @author Alex Rohleder <[email protected]>
 * @copyright 2016 Alex Rohleder
 * @license http://opensource.org/licenses/MIT
 */

namespace Codeburner\Router;

/**
 * Representation of a group of several routes with same
 * controller and respecting the resourceful actions.
 *
 * @author Alex Rohleder <[email protected]>
 */

class Resource extends Group
{

    /**
     * @inheritdoc
     * @throws \BadMethodCallException
     */

    public function setMethod($method)
    {
        throw new \BadMethodCallException("Resources can't chance they http method.");
    }

    /**
     * Remove the routes without the passed methods.
     *
     * @param string|string[] $methods
     * @return self
     */

    public function only($methods)
    {
        $this->filterByMethod((array) $methods, false);
        return $this;
    }

    /**
     * Remove the routes with the passed methods.
     *
     * @param string|string[] $methods
     * @return self
     */

    public function except($methods)
    {
        $this->filterByMethod((array) $methods, true);
        return $this;
    }

    /**
     * Forget the grouped routes filtering by http methods.
     *
     * @param string[] $methods
     * @param bool $alt Should remove?
     */

    private function filterByMethod(array $methods, $alt)
    {
        $methods = array_flip(array_map('strtolower', $methods));

        foreach ($this->routes as $route) {
            if (isset($methods[$route->getAction()[1]]) === $alt) {
                $route->forget();
            }
        }
    }

    /**
     * Translate the "make" or "edit" from resources path.
     *
     * @param string[] $translations
     * @return self
     */

    public function translate(array $translations)
    {
        foreach ($this->routes as $route) {
            $action = $route->getAction()[1];

            if ($action === "make" && isset($translations["make"])) {
                $route->setPatternWithoutReset(str_replace("make", $translations["make"], $route->getPattern()));
            } elseif ($action === "edit" && isset($translations["edit"])) {
                $route->setPatternWithoutReset(str_replace("edit", $translations["edit"], $route->getPattern()));
            }
        }

        return $this;
    }

    /**
     * Add a route or a group of routes to the resource, it means that
     * every added route will now receive the parameters of the resource, like id.
     *
     * @param Route|Group $route
     * @return self
     */

    public function member($route)
    {
        $resource = new self;
        $resource->set($route);
        $this->nest($resource);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Nested routes capture the relation between a resource and another resource.
     *
     * @param self $resource
     * @return self
     */

    public function nest(self $resource)
    {
        foreach ($this->routes as $route) {
            if ($route->getAction()[1] === "show") {
                $this->set($resource->forget()->setPrefix($this->getNestedPrefix($route->getPattern()))); break;
            }
        }

        return $this;
    }

    /**
     * Nest resources but with only build routes with the minimal amount of information
     * to uniquely identify the resource.
     *
     * @param self $resource
     * @return self
     */

    public function shallow(self $resource)
    {
        $newResource = new self;
        $resource->forget();
        $routes = $resource->all();

        foreach ($routes as $route) {
            if (strpos("index make create", $route->getAction()[1]) !== false) {
                $newResource->set($route);
            }
        }

        return $this->nest($newResource);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Resolve the nesting pattern, setting the prefixes based on
     * parent resources patterns.
     *
     * @param string $pattern
     * @return string
     */

    protected function getNestedPrefix($pattern)
    {
        $segments = explode("/", $pattern);
        $pattern = "";

        foreach ($segments as $index => $segment) {
            if (strpos($segment, "{") === 0) {
                   $pattern .= "/{" . $segments[$index - 1] . "_" . ltrim($segment, "{");
            } else $pattern .= $segment;
        }

        return $pattern;
    }

}


1		<?php
2
3		/**
4		* Codeburner Framework.
5		*
6		* @author Alex Rohleder <[email protected]>
7		* @copyright 2016 Alex Rohleder
8		* @license http://opensource.org/licenses/MIT
9		*/
10
11		namespace Codeburner\Router;
12
13		/**
14		* Representation of a group of several routes with same
15		* controller and respecting the resourceful actions.
16		*
17		* @author Alex Rohleder <[email protected]>
18		*/
19
20		class Resource extends Group
21		{
22
23		/**
24		* @inheritdoc
25		* @throws \BadMethodCallException
26		*/
27
28		public function setMethod($method)
29		{
30		throw new \BadMethodCallException("Resources can't chance they http method.");
31		}
32
33		/**
34		* Remove the routes without the passed methods.
35		*
36		* @param string\|string[] $methods
37		* @return self
38		*/
39
40	1	public function only($methods)
41		{
42	1	$this->filterByMethod((array) $methods, false);
43	1	return $this;
44		}
45
46		/**
47		* Remove the routes with the passed methods.
48		*
49		* @param string\|string[] $methods
50		* @return self
51		*/
52
53	1	public function except($methods)
54		{
55	1	$this->filterByMethod((array) $methods, true);
56	1	return $this;
57		}
58
59		/**
60		* Forget the grouped routes filtering by http methods.
61		*
62		* @param string[] $methods
63		* @param bool $alt Should remove?
64		*/
65
66	2	private function filterByMethod(array $methods, $alt)
67		{
68	2	$methods = array_flip(array_map('strtolower', $methods));
69
70	2	foreach ($this->routes as $route) {
71	2	if (isset($methods[$route->getAction()[1]]) === $alt) {
72	2	$route->forget();
73	2	}
74	2	}
75	2	}
76
77		/**
78		* Translate the "make" or "edit" from resources path.
79		*
80		* @param string[] $translations
81		* @return self
82		*/
83
84		public function translate(array $translations)
85		{
86		foreach ($this->routes as $route) {
87		$action = $route->getAction()[1];
88
89		if ($action === "make" && isset($translations["make"])) {
90		$route->setPatternWithoutReset(str_replace("make", $translations["make"], $route->getPattern()));
91		} elseif ($action === "edit" && isset($translations["edit"])) {
92		$route->setPatternWithoutReset(str_replace("edit", $translations["edit"], $route->getPattern()));
93		}
94		}
95
96		return $this;
97		}
98
99		/**
100		* Add a route or a group of routes to the resource, it means that
101		* every added route will now receive the parameters of the resource, like id.
102		*
103		* @param Route\|Group $route
104		* @return self
105		*/
106
107		public function member($route)
108		{
109		$resource = new self;
110		$resource->set($route);
111		$this->nest($resource);
		0 ignored issues – show Documentation introduced 2016-02-22 14:19 UTC by Report Bug Copy Issue Report `$resource` is of type `object<Codeburner\Router\Resource>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112		}
113
114		/**
115		* Nested routes capture the relation between a resource and another resource.
116		*
117		* @param self $resource
118		* @return self
119		*/
120
121	3	public function nest(self $resource)
122		{
123	3	foreach ($this->routes as $route) {
124	3	if ($route->getAction()[1] === "show") {
125	3	$this->set($resource->forget()->setPrefix($this->getNestedPrefix($route->getPattern()))); break;
126		}
127	3	}
128
129	3	return $this;
130		}
131
132		/**
133		* Nest resources but with only build routes with the minimal amount of information
134		* to uniquely identify the resource.
135		*
136		* @param self $resource
137		* @return self
138		*/
139
140	1	public function shallow(self $resource)
141		{
142	1	$newResource = new self;
143	1	$resource->forget();
144	1	$routes = $resource->all();
145
146	1	foreach ($routes as $route) {
147	1	if (strpos("index make create", $route->getAction()[1]) !== false) {
148	1	$newResource->set($route);
149	1	}
150	1	}
151
152	1	return $this->nest($newResource);
		0 ignored issues – show Documentation introduced 2016-02-22 14:19 UTC by Report Bug Copy Issue Report `$newResource` is of type `object<Codeburner\Router\Resource>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
153		}
154
155		/**
156		* Resolve the nesting pattern, setting the prefixes based on
157		* parent resources patterns.
158		*
159		* @param string $pattern
160		* @return string
161		*/
162
163	3	protected function getNestedPrefix($pattern)
164		{
165	3	$segments = explode("/", $pattern);
166	3	$pattern = "";
167
168	3	foreach ($segments as $index => $segment) {
169	3	if (strpos($segment, "{") === 0) {
170	3	$pattern .= "/{" . $segments[$index - 1] . "_" . ltrim($segment, "{");
171	3	} else $pattern .= $segment;
172	3	}
173
174	3	return $pattern;
175		}
176
177		}
178

codeburnerframework / routing

Resource::member() A last analyzed 2016-02-22 17:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Resource::member() A
last analyzed 2016-02-22 17:31 UTC