Application::setRequest() - Code Metrics - Inspection of "Added the ability to run same server stack on diff..." - slickframework/mvc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a04fca...2fcac9 )

by Filipe

created 2016-06-23 18:04 UTC

Application::setRequest() A

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc;

use Interop\Container\ContainerInterface;
use Slick\Configuration\Configuration;
use Slick\Di\Container;
use Slick\Di\ContainerBuilder;
use Slick\Http\PhpEnvironment\MiddlewareRunnerInterface;
use Slick\Http\PhpEnvironment\Request;
use Slick\Http\PhpEnvironment\Response;

/**
 * Class Application
 * @package Slick\Mvc
 */
class Application
{

    /**
     * @var ContainerInterface
     */
    private static $container;

    /**
     * @var string
     */
    private $configPath;

    /**
     * @var Request
     */
    private $request;

    /**
     * @var MiddlewareRunnerInterface
     */
    private $runner;

    /**
     * @var Response
     */
    private $response;

    /**
     * @var ContainerInterface
     */
    private static $defaultContainer;

    /**
     * Creates an application with an HTTP request
     *
     * If no request is provided then a Slick\Http\PhpEnvironment\Request is
     * created with values form current php environment settings.
     *
     * @param Request $request
     */
    public function __construct(Request $request = null)
    {
        $this->request = $request;
        Configuration::addPath(__DIR__.'/Configuration');
        $definitions = include __DIR__.'/Configuration/services.php';
        self::$defaultContainer = (
            new ContainerBuilder($definitions)
        )
        ->getContainer();
    }

    /**
     * Sets a new request
     *
     * @param Request $request
     *
     * @return Application
     */
    public function setRequest(Request $request)
    {
        $this->request = $request;
        $this->getContainer()->register('request', $request);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }

    /**
     * Gets the application dependency injection container
     *
     * @return ContainerInterface|Container
     */
    public function getContainer()
    {
        if (is_null(self::$container)) {
            self::$container = $this->checkContainer();
        }
        return self::$container;
    }

    /**
     * Sets the dependency injection container
     *
     * @param ContainerInterface $container
     */
    public static function setContainer(ContainerInterface $container)
    {
        self::$container = $container;
    }

    /**
     * Returns the application dependency container
     *
     * @return ContainerInterface|Container
     */
    public static function container()
    {
        if (null == self::$container) {
            $app = new static;
            $app->getContainer();
        }
        return self::$container;
    }

    /**
     * Set middleware runner
     *
     * @param MiddlewareRunnerInterface $runner
     *
     * @return $this|self|Application
     */
    public function setRunner(MiddlewareRunnerInterface $runner)
    {
        $this->runner = $runner;
        return $this;
    }

    /**
     * Returns the processed response
     *
     * @return Response
     */
    public function getResponse()
    {
        if (is_null($this->response)) {
            $this->response = $this->getRunner()->run();
        }
        return $this->response;
    }

    /**
     * Gets the HTTP middleware runner for this application
     *
     * @return MiddlewareRunnerInterface
     */
    public function getRunner()
    {
        if (null === $this->runner) {
            $runner = $this->getContainer()
                ->get('middleware.runner')
                ->setRequest($this->getRequest())
            ;
            $this->setRunner($runner);
        }
        return $this->runner;
    }

    /**
     * Set configuration path
     * 
     * @param string $configPath
     * 
     * @return Application|self
     */
    public function setConfigPath($configPath)
    {
        $this->configPath = $configPath;
        Configuration::addPath($configPath);
        return $this;
    }

    /**
     * Gets configuration path
     * 
     * @return string
     */
    public function getConfigPath()
    {
        if (null == $this->configPath) {
            $this->configPath = getcwd().'/Configuration';
            Configuration::addPath($this->configPath);
        }
        return $this->configPath;
    }

    /**
     * Gets HTTP request object
     *
     * @return Request
     */
    public function getRequest()
    {
        if (null === $this->request) {
            $this->request = $this->getContainer()
                ->get('request');
        }
        return $this->request;
    }

    /**
     * Gets container with user overridden settings
     * 
     * @return ContainerInterface|\Slick\Di\Container
     */
    protected function checkContainer()
    {
        $container = self::$defaultContainer;
        if (
            null != $this->configPath &&
            file_exists($this->configPath.'/services.php')
        ) {
            $definitions = include $this->configPath.'/services.php';
            $container = (
                new ContainerBuilder(
                    $definitions,
                    true
                )
            )->getContainer();
        }
        return $container;
    }

}

1		<?php
2
3		/**
4		* This file is part of slick/mvc package
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace Slick\Mvc;
11
12		use Interop\Container\ContainerInterface;
13		use Slick\Configuration\Configuration;
14		use Slick\Di\Container;
15		use Slick\Di\ContainerBuilder;
16		use Slick\Http\PhpEnvironment\MiddlewareRunnerInterface;
17		use Slick\Http\PhpEnvironment\Request;
18		use Slick\Http\PhpEnvironment\Response;
19
20		/**
21		* Class Application
22		* @package Slick\Mvc
23		*/
24		class Application
25		{
26
27		/**
28		* @var ContainerInterface
29		*/
30		private static $container;
31
32		/**
33		* @var string
34		*/
35		private $configPath;
36
37		/**
38		* @var Request
39		*/
40		private $request;
41
42		/**
43		* @var MiddlewareRunnerInterface
44		*/
45		private $runner;
46
47		/**
48		* @var Response
49		*/
50		private $response;
51
52		/**
53		* @var ContainerInterface
54		*/
55		private static $defaultContainer;
56
57		/**
58		* Creates an application with an HTTP request
59		*
60		* If no request is provided then a Slick\Http\PhpEnvironment\Request is
61		* created with values form current php environment settings.
62		*
63		* @param Request $request
64		*/
65	8	public function __construct(Request $request = null)
66		{
67	8	$this->request = $request;
68	8	Configuration::addPath(__DIR__.'/Configuration');
69	8	$definitions = include __DIR__.'/Configuration/services.php';
70	8	self::$defaultContainer = (
71	8	new ContainerBuilder($definitions)
72	1	)
73	8	->getContainer();
74	8	}
75
76		/**
77		* Sets a new request
78		*
79		* @param Request $request
80		*
81		* @return Application
82		*/
83	2	public function setRequest(Request $request)
84		{
85	2	$this->request = $request;
86	2	$this->getContainer()->register('request', $request);
		0 ignored issues – show Bug introduced 2016-06-23 18:10 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Interop\Container\ContainerInterface` as the method `register()` does only exist in the following implementations of said interface: `Slick\Di\Container`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
87	2	return $this;
88		}
89
90		/**
91		* Gets the application dependency injection container
92		*
93		* @return ContainerInterface\|Container
94		*/
95	6	public function getContainer()
96		{
97	6	if (is_null(self::$container)) {
98	2	self::$container = $this->checkContainer();
99	1	}
100	6	return self::$container;
101		}
102
103		/**
104		* Sets the dependency injection container
105		*
106		* @param ContainerInterface $container
107		*/
108	22	public static function setContainer(ContainerInterface $container)
109		{
110	22	self::$container = $container;
111	22	}
112
113		/**
114		* Returns the application dependency container
115		*
116		* @return ContainerInterface\|Container
117		*/
118	20	public static function container()
119		{
120	20	if (null == self::$container) {
121	2	$app = new static;
122	2	$app->getContainer();
123	1	}
124	20	return self::$container;
125		}
126
127		/**
128		* Set middleware runner
129		*
130		* @param MiddlewareRunnerInterface $runner
131		*
132		* @return $this\|self\|Application
133		*/
134	2	public function setRunner(MiddlewareRunnerInterface $runner)
135		{
136	2	$this->runner = $runner;
137	2	return $this;
138		}
139
140		/**
141		* Returns the processed response
142		*
143		* @return Response
144		*/
145	2	public function getResponse()
146		{
147	2	if (is_null($this->response)) {
148	2	$this->response = $this->getRunner()->run();
149	1	}
150	2	return $this->response;
151		}
152
153		/**
154		* Gets the HTTP middleware runner for this application
155		*
156		* @return MiddlewareRunnerInterface
157		*/
158	2	public function getRunner()
159		{
160	2	if (null === $this->runner) {
161	2	$runner = $this->getContainer()
162	2	->get('middleware.runner')
163	2	->setRequest($this->getRequest())
164	1	;
165	2	$this->setRunner($runner);
166	1	}
167	2	return $this->runner;
168		}
169
170		/**
171		* Set configuration path
172		*
173		* @param string $configPath
174		*
175		* @return Application\|self
176		*/
177		public function setConfigPath($configPath)
178		{
179		$this->configPath = $configPath;
180		Configuration::addPath($configPath);
181		return $this;
182		}
183
184		/**
185		* Gets configuration path
186		*
187		* @return string
188		*/
189		public function getConfigPath()
190		{
191		if (null == $this->configPath) {
192		$this->configPath = getcwd().'/Configuration';
193		Configuration::addPath($this->configPath);
194		}
195		return $this->configPath;
196		}
197
198		/**
199		* Gets HTTP request object
200		*
201		* @return Request
202		*/
203	4	public function getRequest()
204		{
205	4	if (null === $this->request) {
206	2	$this->request = $this->getContainer()
207	2	->get('request');
208	1	}
209	4	return $this->request;
210		}
211
212		/**
213		* Gets container with user overridden settings
214		*
215		* @return ContainerInterface\|\Slick\Di\Container
216		*/
217	2	protected function checkContainer()
218		{
219	2	$container = self::$defaultContainer;
220		if (
221	2	null != $this->configPath &&
222	1	file_exists($this->configPath.'/services.php')
223	1	) {
224		$definitions = include $this->configPath.'/services.php';
225		$container = (
226		new ContainerBuilder(
227		$definitions,
228		true
229		)
230		)->getContainer();
231		}
232	2	return $container;
233		}
234
235		}

slickframework / mvc

Push — master ( a04fca...2fcac9 )

Application::setRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like