Geolocate::saveInSession() - Code Metrics - Inspection of "added ReadResponse::continueOnError() option" - oscarotero/psr7-middlewares - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1b2d0a...89ea1a )

by Oscar

created 2016-02-23 23:17 UTC

Geolocate::saveInSession() A

↳ Parent: Geolocate

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Psr7Middlewares\Middleware;

use Psr7Middlewares\Middleware;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use Geocoder\Geocoder;
use Geocoder\ProviderAggregator;
use Geocoder\Provider\FreeGeoIp;
use Geocoder\Model\AddressCollection;
use Ivory\HttpAdapter\FopenHttpAdapter;
use RuntimeException;

/**
 * Middleware to geolocate the client using the ip.
 */
class Geolocate
{
    const KEY = 'GEOLOCATE';

    /**
     * @var Geocoder
     */
    private $geocoder;

    /**
     * @var bool
     */
    private $saveInSession = false;

    /**
     * Returns the client location.
     *
     * @param ServerRequestInterface $request
     *
     * @return AddressCollection|null
     */
    public static function getLocation(ServerRequestInterface $request)
    {
        return Middleware::getAttribute($request, self::KEY);
    }

    /**
     * Constructor. Set the geocoder instance.
     *
     * @param null|Geocoder $geocoder
     */
    public function __construct(Geocoder $geocoder = null)
    {
        if ($geocoder === null) {
            $geocoder = new ProviderAggregator();
            $geocoder->registerProvider(new FreeGeoIp(new FopenHttpAdapter()));
        }

        $this->geocoder = $geocoder;
    }

    /**
     * Wheter or not save the geolocation in a session variable
     * 
     * @param bool $save
     * 
     * @return self
     */
    public function saveInSession($save = true)
    {
        $this->saveInSession = $save;

        return $this;
    }

    /**
     * Execute the middleware.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     * @param callable               $next
     *
     * @return ResponseInterface
     */
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        if (!Middleware::hasAttribute($request, ClientIp::KEY)) {
            throw new RuntimeException('Geolocate middleware needs ClientIp executed before');
        }

        if ($this->saveInSession && !Middleware::hasAttribute($request, Middleware::STORAGE_KEY)) {
            throw new RuntimeException('Csrf middleware needs a storage defined');
        }

        $ip = ClientIp::getIp($request);

        if ($ip !== null) {
            if (!$this->saveInSession || ($address = self::fromSession($request, $ip)) === null) {
                $address = $this->geocoder->geocode($ip);
            }

            $request = Middleware::setAttribute($request, self::KEY, $address);

            if ($this->saveInSession) {
                self::toSession($request, $ip, $address);
            }
        }

        return $next($request, $response);
    }

    /**
     * Returns the geolocation from the session storage
     * 
     * @param ResponseInterface      $response
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $ip
     * 
     * @return AddressCollection|null
     */
    static private function fromSession(ServerRequestInterface $request, $ip)

    {
        $storage = Middleware::getAttribute($request, Middleware::STORAGE_KEY);
        $ips = $storage->get(self::KEY);

        if (isset($ips[$ip])) {
            return new AddressCollection($ips[$ip]);
        }
    }

    /**
     * Saves the geolocation in the session storage
     * 
     * @param ResponseInterface      $response
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $ip
     * @param AddressCollection $address
     */
    static private function toSession(ServerRequestInterface $request, $ip, AddressCollection $address)

    {
        $storage = Middleware::getAttribute($request, Middleware::STORAGE_KEY);
        $ips = $storage->get(self::KEY) ?: [];
        $ips[$ip] = $address->all();
        $storage->set(self::KEY, $ips);
    }
}


1			<?php
2
3			namespace Psr7Middlewares\Middleware;
4
5			use Psr7Middlewares\Middleware;
6			use Psr\Http\Message\ServerRequestInterface;
7			use Psr\Http\Message\ResponseInterface;
8			use Geocoder\Geocoder;
9			use Geocoder\ProviderAggregator;
10			use Geocoder\Provider\FreeGeoIp;
11			use Geocoder\Model\AddressCollection;
12			use Ivory\HttpAdapter\FopenHttpAdapter;
13			use RuntimeException;
14
15			/**
16			* Middleware to geolocate the client using the ip.
17			*/
18			class Geolocate
19			{
20			const KEY = 'GEOLOCATE';
21
22			/**
23			* @var Geocoder
24			*/
25			private $geocoder;
26
27			/**
28			* @var bool
29			*/
30			private $saveInSession = false;
31
32			/**
33			* Returns the client location.
34			*
35			* @param ServerRequestInterface $request
36			*
37			* @return AddressCollection\|null
38			*/
39			public static function getLocation(ServerRequestInterface $request)
40			{
41			return Middleware::getAttribute($request, self::KEY);
42			}
43
44			/**
45			* Constructor. Set the geocoder instance.
46			*
47			* @param null\|Geocoder $geocoder
48			*/
49			public function __construct(Geocoder $geocoder = null)
50			{
51			if ($geocoder === null) {
52			$geocoder = new ProviderAggregator();
53			$geocoder->registerProvider(new FreeGeoIp(new FopenHttpAdapter()));
54			}
55
56			$this->geocoder = $geocoder;
57			}
58
59			/**
60			* Wheter or not save the geolocation in a session variable
61			*
62			* @param bool $save
63			*
64			* @return self
65			*/
66			public function saveInSession($save = true)
67			{
68			$this->saveInSession = $save;
69
70			return $this;
71			}
72
73			/**
74			* Execute the middleware.
75			*
76			* @param ServerRequestInterface $request
77			* @param ResponseInterface $response
78			* @param callable $next
79			*
80			* @return ResponseInterface
81			*/
82			public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
83			{
84			if (!Middleware::hasAttribute($request, ClientIp::KEY)) {
85			throw new RuntimeException('Geolocate middleware needs ClientIp executed before');
86			}
87
88			if ($this->saveInSession && !Middleware::hasAttribute($request, Middleware::STORAGE_KEY)) {
89			throw new RuntimeException('Csrf middleware needs a storage defined');
90			}
91
92			$ip = ClientIp::getIp($request);
93
94			if ($ip !== null) {
95			if (!$this->saveInSession \|\| ($address = self::fromSession($request, $ip)) === null) {
96			$address = $this->geocoder->geocode($ip);
97			}
98
99			$request = Middleware::setAttribute($request, self::KEY, $address);
100
101			if ($this->saveInSession) {
102			self::toSession($request, $ip, $address);
103			}
104			}
105
106			return $next($request, $response);
107			}
108
109			/**
110			* Returns the geolocation from the session storage
111			*
112			* @param ResponseInterface $response
			0 ignored issues – show Bug introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report There is no parameter named `$response`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
113			* @param string $ip
114			*
115			* @return AddressCollection\|null
116			*/
117			static private function fromSession(ServerRequestInterface $request, $ip)
			0 ignored issues – show Coding Style introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
118			{
119			$storage = Middleware::getAttribute($request, Middleware::STORAGE_KEY);
120			$ips = $storage->get(self::KEY);
121
122			if (isset($ips[$ip])) {
123			return new AddressCollection($ips[$ip]);
124			}
125			}
126
127			/**
128			* Saves the geolocation in the session storage
129			*
130			* @param ResponseInterface $response
			0 ignored issues – show Bug introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report There is no parameter named `$response`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
131			* @param string $ip
132			* @param AddressCollection $address
133			*/
134			static private function toSession(ServerRequestInterface $request, $ip, AddressCollection $address)
			0 ignored issues – show Coding Style introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
135			{
136			$storage = Middleware::getAttribute($request, Middleware::STORAGE_KEY);
137			$ips = $storage->get(self::KEY) ?: [];
138			$ips[$ip] = $address->all();
139			$storage->set(self::KEY, $ips);
140			}
141			}
142

oscarotero / psr7-middlewares

Push — master ( 1b2d0a...89ea1a )

Geolocate::saveInSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like